Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 2.33 KB
Raw

Contribute to ByteLegend

All Kinds of Contribution are Welcomed

  • Game data contributor:
    • You see a typo or bad translation in a text, like mission description, UI prompt, etc.
    • You see a tutorial better than any existing ones, and you want to share it with the whole world (and earn coins)!
  • Game map contributor:
    • You see a flaw in the game map, like a bad tile image, or incorrectly marked tile (e.g. you can walk into a sea tile).
  • Game code contributor:
    • You see a bug in the game code (either frontend or backend or game script) and you want to fix it.
  • Game creator:
    • You want to build a new map on top of infrastructure provided by ByteLegend.

Prerequisite

You need to install the software:

  • For game data contributor: your favorite text editor.
  • For game map contributor: a map editor named Tiled.
  • For game code contributor and game creator:

Contribute to Game Data

DON'T clone ByteLegend/ByteLegend main repo if you just want to contribute to game text data - it's several GBs - because it contains a lot of game resources.

If you see bad texts in the game, you can clone the game data repo ByteLegend/game-data. We intentionally put all text resources in a separate repo so you can clone it must faster.

Search the wrong text with your favorite text editor, fix the issue then create a pull request.

You can also follow the guidance here to fix the issue via GitHub web UI.

Contribute Better Tutorials

TBD

Contribute to Game Map

See Game Map Contributor Guide

Contribute to Game Code

See Game Code Contributor Guide

Build a New Game Map

It's possible to build a new game map as tutorial or documentation for your project. See Create a New Map for how to do so.