1. 1. Introduction
    1. 1.1. What is Veloren?
    2. 1.2. Who develops Veloren?
    3. 1.3. Download
  2. 2. Veloren for Players
    1. 2.1. Introduction
      1. 2.1.1. Reporting Bugs
      2. 2.1.2. Changelog
      3. 2.1.3. Roadmap
      4. 2.1.4. FAQ
    2. 2.2. Airshipper - Launcher
    3. 2.3. Voxygen - 3D client frontend
    4. 2.4. Commands
    5. 2.5. Userdata Folder Structure
    6. 2.6. Hosting a Server
      1. 2.6.1. Setup guides
        1. 2.6.1.1. On Your Computer
        2. 2.6.1.2. On Docker
        3. 2.6.1.3. On The Raspberry Pi
      2. 2.6.2. Configuring the server
      3. 2.6.3. In-Game Build Mode
    7. 2.7. Environment Variables
    8. 2.8. Generating or loading a custom world
    9. 2.9. Troubleshooting
    10. 2.10. Performance
  3. 3. Veloren for Contributors
    1. 3.1. Introduction
      1. 3.1.1. Development tools
      2. 3.1.2. Working with git
      3. 3.1.3. Compiling
      4. 3.1.4. Cross-Compiling
      5. 3.1.5. Before you contribute
      6. 3.1.6. Joining a team
      7. 3.1.7. FAQ
      8. 3.1.8. Troubleshooting
      9. 3.1.9. Tracking Issues
    2. 3.2. For Developers
      1. 3.2.1. Installing an IDE
      2. 3.2.2. Learning Rust
      3. 3.2.3. ECS
      4. 3.2.4. Project Architecture
      5. 3.2.5. Coordinate Systems
      6. 3.2.6. Debugging
      7. 3.2.7. Performance Analysis
    3. 3.3. For Artists
      1. 3.3.1. Voxel Models
      2. 3.3.2. Audio
      3. 3.3.3. Graphics
    4. 3.4. For Translators
      1. 3.4.1. Game
      2. 3.4.2. Book
      3. 3.4.3. Website
    5. 3.5. For Animators
      1. 3.5.1. Animate a skeleton
    6. 3.6. For Game Designers
      1. 3.6.1. Write a Proposal
    7. 3.7. For Writers
      1. 3.7.1. Extend the book
      2. 3.7.2. Write Lore
    8. 3.8. For DevOps
      1. 3.8.1. Providing a CI runner
    9. 3.9. For Meta
      1. 3.9.1. Releases
        1. 3.9.1.1. Game
        2. 3.9.1.2. Airshipper
      2. 3.9.2. Packaging
        1. 3.9.2.1. Game
    10. 3.10. Guides
      1. 3.10.1. Adding Armor
      2. 3.10.2. Adding Sprites
      3. 3.10.3. Adding Weapons
      4. 3.10.4. Using const_tweaker
      5. 3.10.5. Adding Weapon Skills
    11. 3.11. For Modders
      1. 3.11.1. Writing a plugin
    12. 3.12. For Journalists
      1. 3.12.1. Press Kit
  4. 4. Internals
    1. 4.1. Worldgen
    2. 4.2. Wiring

Veloren: An Owner's Manual

Available Setup Guides

Choose the instructions for the runtime platform on which you want to run Veloren:

  • Running a Server on Your PC
  • Running a Server using Docker (For Dedicated Servers)
  • Running a Server on a Raspberry Pi