Getting Started

Contributing to RedMew

There's many ways you can contribute to the RedMew repository. Most importantly is that you do not need to have any particular experience with LUA, and to some extent any programming knowledge.

The RedMew codebase is a framework upon which most of the maps, we at RedMew play, is built. The framework is divided into 5 areas:

Features
Contains generic cross map features that can be enabled to customize the scenario.
Contributing requires minor programming experience and up, depending on the complexity of the feature.

Locale
Contains locales (in english) for a large part of the framework and features. Also contains user contributed translations.
Contributing requires no programming experience, but requires bilingual skills

Map_gen
Contains maps, map specific dependencies and map generation tools for creating unique maps and landscapes.
Contributing requires different level of programming experience depending on the complexity of the map. Ranging from no experience to comfortable in LUA

Resources
Contains resources used by features and maps, like setting, messages and colors.
Contributing requires no or some experience in programming, depending on the complexity of the resource file

Utils
Contains the heart of the framework, most noticeable is the event, game and global modules giving powerful tools in scenario creation.
Contributing requires being comfortable in LUA

Getting started

Be sure to know how to setup the framework before proceeding:
User-guide
Navigating the config

Depending upon which area you'd like to contribute within, you should take a look at some of these resources:

Dev-environment - Look here for information about setting up a development environment, alternatively you could use notepad++ to perform minor development tasks.

Styleguide - Look here for information about how to format your code for acceptance into the develop-branch.

Logging, debugging and linting - Look here for information about to handle debugging your code.

Image to Map - Look here for information about how to convert a image to use as a map or entity in map generation.

Creating a new map - Look here for information about how to setup files for a new scenario or map.

Using the Builders - Look here for information about how to leverage the power of our builders module to assist in map generation.

Translating - Look here for information about how to translate the RedMew framework into another language

Learning LUA - Look here to learn how to program in LUA

You can find more resources in the sidebar or on redmew.com/discord inside #devtalk and #mapgen. You'll find us available to answer any of your questions there.