mirror of
https://github.com/2006-Scape/apollo.git
synced 2026-07-02 16:49:12 +00:00
Major
41 lines
2.6 KiB
Markdown
41 lines
2.6 KiB
Markdown
# Apollo
|
|
|
|
Apollo is a high-performance, modular RuneScape emulator with a collection of utilities for managing data files and plugins.
|
|
|
|
### Developer information
|
|
|
|
Most discussion related to the development of Apollo happens on our [Discord](https://discord.gg/Fuft67P). If you have a problem and can't get in touch with anyone, create a GitHub issue. If making a pull request, please make sure all tests are still passing after making your changes, and that your code style is consistent with the rest of Apollo.
|
|
|
|
### Getting started
|
|
|
|
Apollo uses the [gradle build tool](https://gradle.org), so this must be installed in order to build Apollo.
|
|
|
|
1. Run `gradle build` in the Apollo directory to download dependencies and build Apollo.
|
|
2. Place the full cache of the client revision you want to target in `data/fs/[revision]` - by default Apollo is compatible with the 377 revision, so the cache would be placed in `data/fs/377`.
|
|
3. Place an `rsa.pem` file containing the RSA private key to be used by the server in `data/`. Apollo comes with a generator that will write the pem file to the appropriate location - see `org.apollo.util.tools.RsaKeyGenerator`. If you use the generator you must replace the public key and modulus used by your client (the tool will print the new values).
|
|
4. If you are targeting a different client revision, run the `EquipmentUpdater` (in `org.apollo.cache.tools`), which identifies the appropriate combat skill levels required to wear equipment. Note that you may have to update the tool yourself if the revision contains equipment not found in 377.
|
|
|
|
Apollo is now ready, and can be started using `gradle run`. You may wish to change the player serializer defined in `login.xml` - by default player data is not saved, and all users who log in will have administrator rights.
|
|
|
|
### Contributing
|
|
|
|
Please see [contributing to Apollo](CONTRIBUTING.md).
|
|
|
|
### Acknowledgements
|
|
|
|
We'd like to thank the list of service providers/development tool vendors below for offering their products to the Apollo project free of charge.
|
|
|
|
---
|
|
|
|
#### [](https://www.yourkit.com/java/profiler/index.jsp)
|
|
|
|
YourKit supports open source projects with its full-featured Java Profiler.
|
|
YourKit, LLC is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>
|
|
and <a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>,
|
|
innovative and intelligent tools for profiling Java and .NET applications.
|
|
|
|
#### [Travis CI](https://travis-ci.org)
|
|
|
|
Travis CI is a Continuous Integration platform that allows for setup of automated testing with minimal configuration.
|
|
|