Prerequisite
Thank you for your interest in contributing ! Make sure to read the Introduction section and if you want the section For Developers. Otherwise feel free to jump around as you need.
Introduction
FAQ
Start contributing !
There is various way to contribute to veloren's development, no matter if you got a degree or taught yourself. Shall it be code, assets, creatures, bug fixes, the book donation or the wiki itself !
Embrace the wiki
We are glad that you want to collaborate with the Veloren Wiki, it is very important that you collaborate and participate in the collaborative process of cataloging and recording everything about the game.
Extend the book
You can find the source for this book at our GitLab, feel free to make changes, correct errors and add more content.
Translation
There are different ways to contribute translations, but the most straightforward way is using git and rust.
Extinguish bugs
We will covers how to report bugs.
The voxel art
We use MagicaVoxel to create Veloren's assets and some sprites for smaller object that don't render well in voxel
The music and SFX
Tracking issues
See what progress needs to be made an figure out what you'd like to work on!
DevOps
Developpers
Work in progress
Artist
Voxel Model
https://book.veloren.net/contributors/artists/voxel-models.html
ArtChanny has the most up to date tutorials so they are strongly recommended. How does MagicaVoxel work with Veloren? Usually, 1 voxel in MagicaVoxel is 1 voxel in Veloren. However, this does not apply to all Veloren assets. We have something called sprites, made to represent smaller objects that wouldn’t look good in a 1 for 1 voxel conversion. That’s why they use a 1 for 11 blocks conversion, that’s to say that 1 block in Veloren will be 11 blocks in MagicaVoxel. (Note:We are currently in the process of switching to 1 for 9 but it is still 1 for 11 at the moment). Please, when making your custom palettes, DO NOT use the three bottom rows, as they are particular indexes for Veloren.
Recommended videos to learn more about MagicaVoxel:
Basics:
- https://youtu.be/BxuY48y6JEM
- https://youtu.be/z-ONzlJdaTg
- https://youtu.be/OmNt4dwqi30
- https://youtu.be/vEcXEFqjoXM
- https://youtu.be/LLnqFMN5DS4
- https://youtu.be/U1nSNjoT6xs
Hotkeys and shortcuts:
More advanced:
For big projects:
Audio
https://book.veloren.net/contributors/artists/audio.html
The best way to contribute audio is to first visit the Discord, ask for a contributor role in the #new-contributors channel, and start a conversation in the #audio channel.
All sound files should be in .ogg format, exported at Variable Bit Rate level 5. The quick and easy way to do this is to export as a .wav, open it in Audacity, and export it again as a .ogg at compression level "5".
Translator
https://book.veloren.net/contributors/translators/game.html
There are different ways to contribute translations, but the most straightforward way is using git and rust. You don't need to compile the game, although debug builds have useful features like hot-reloading for translations, that allow you to translate the game while running it. Tooling to check the status of your translations doesn't require compiling the full game, but it still requires the Rust toolchain. Read this guide on basic tooling (git lfs is important), working with git (git is not most user friendly thing, ask if you don't understand something), compile instructions, and contribution instructions (most important).
Alternatively, you can just work on directly on assets shipped by Airshipper. Beware that updating your game will purge all your work, so think about using VELOREN_ASSETS_OVERRIDE