There are not many rules, but they are the following:
- Do not modify the vanilla source files that are not in this repository, even if it's to make some of its fields public. This is to maintain cross-mod compatibility. If necessary, use Reflection or extensions. This is the most important guideline.
- If making engine-dependent methods, make sure as much equal support is to be given to all three engines (Slick, Swing and SDL) as possible. This is to provide an equal experience to every user, no matter their choice of engine to run. If some features/functionality is impossible (or far too slow) to implement in a certain engine, do not worry too much.
- Javadoc comments are essential on complex libraries. Modes and mode-specific objects can be left alone at the contributor's discretion, but an explanation must be given if asked.
- If making your own modes, libraries or other class files to go into this pack, make your own root folder in the src directory (e.g. if you want your root to be johndoe, make a johndoe package root in the src folder). This is for organisation purposes, and to give credit where credit is due. This also applies to any custom SFX that you use, but not custom images or BGM.
- Always branch before making source changes. This stops the CI from being activated too many times.
There are also a few optional guidelines that serve to make other contributors' lives easier:
- Make simpler/less-specific overloads of methods in libraries if existing methods are complicated. This makes general-use cases easier to type and debug.
- When making onCustom-centric modes, try to use the structure similar to that in GameEngine. This makes code easier to organise and debug.
Of course:
- Be polite.
- Be efficient.
- Have a plan to fix every bug you find.