---

This guide will cover some basic information to get you started on contributions. For a vague style guide(if you need it) you can check our | Style Guide |.

We welcome many different kinds of contributions, such as:

• Source Code Work
• Documentation
• Bug Reports
• Artwork
• Audio

For code/art/audio you should peek at our | Design Docmentation | for feature and thematic references.

No AI has been used in the creation of any existing content. We hope to keep it that way. So right now any AI contributions will not be used.

Code

Important Notes

Code is broken into 3 core groupings, each extremely important. For most code related contributions, you should contact us before starting.

Source Code

Source code contributions are related to any direct additions to the core code that runs the mod.

• Features
• Bug Fixes
• Refactoring

For all changes, we typically run a few types of extension/plug-ins to support consistent code.

• Stylua: Default settings, used to consistently format code.
• Better Align, equivalent(optional): We try to line up operators, where it makes sense.

These were added in right before beta release. So a lot of files are not formatted completely.

Features

Features should be in line with existing design or goals. This also includes content additions, which can be much simpler to implement. If a complex feature is added, please include some amount of documentation within the source code.

Bug Fixes

Bug fixes should provide proper info on what/why/how when sending a request.

Refactoring

Refactoring should be done with some amount of prior conversation, or based on an existing note to do so in the source code.

Automated testing does not yet exist, so expect requests to potentially take time to fulfill.

Documentation

Guides, explanations, visual updates, etc... are welcome additions to our documentation. For the moment, we keep our code specific documentation within the source code(we may change this later).

Documentation can also refer to the mods general wiki. Currently there is not one, but any progress or work towards having one is welcome.

Bug Reports

Typically follow the format:

• What happened
• What did you expect to happen
• When, how often

Save files, logs, videos, pictures are all important and should be included where possible. Some other things to remember:

• Does this report already exist?
• What version of the game/mod is running?
• What other mods are installed?

Artwork

Artwork is fairly subjective, so inclusions and use-cases will vary case by case. We will accept most things, but cannot guarantee it will be used. Some important things to remember:

• If purchased ensure:
  • Do you have the license to provide it?
  • Can we actually use it in this project?
  • Was it created using AI or AI tools?
• Does it fit either the games original theme, or the mods?
• Resolutions should be on the lower side < 1080x1080
• Frame rates <= 60

We are always in needs of a variety of different artwork such as:

• Icons
  • Weapons, armor, items, equipment, etc...
• Enemies(or companions)
  • Minions, bosses, hives
  • Ideally 4 directional
  • Needs movement animations at a minimum
• Characters
  • 4-8 directional
  • Movements, attacks, mining, etc...
• Animations
  • Bullets, ARPG attacks, healing, interactions
  • 30 FPS typically
  • Lower resolution, based on scale however

Just contact us when you're ready to send things over, or need more information.

Audio

Follow some similar rules as above:

• If purchased ensure:
  • Do you have the license to provide it?
  • Can we actually use it in this project?
  • Was it created using AI or AI tools?
• Does it fit either the games original theme, or the mods?

We can always use:

• Gun shots, weapon sounds
• ARPG attack sounds
• Ability sounds
• Interaction sounds

Not much else to say, contact us to send things over as needed.