Giter VIP home page Giter VIP logo

frangiclave-mod-repository's Introduction

frangiclave-mod-repository

A collection of Frangiclave-enhanced mods for Cultist Simulator.

This is a community repository of mods for Cultist Simulator that depend on frangiclave-patch to work and which should be applied with frangiclave-mod-manager

License: All mods are the sole property of their authors. By contributing your mod to this repository, you agree to give us permission to redistribute it.

Submitting a mod

If you have created a mod that you wish to submit to the repository, follow these steps (you will need to have installed and configured Git on your machine):

  1. Create a Github account, or sign in to your existing one.
  2. Fork the repository. As a best practice, you should keep this repository up-to-date with the main one, to avoid potential conflicts.
  3. Clone the newly-created repository to your machine.
  4. Add your mod's files in a new folder in the mods/<mod_name>/<version> directory, where <mod_name> is a unique name for your mod's folder and <version> is the corresponding version of your mod.
  5. Push your changes to your repository (either on the master branch or another branch of your choosing).
  6. Submit a merge request which adds your mod's files to the repository and wait for it to be reviewed.
    • Each merge request should only ever add or update a single mod, and should only affect files of a mod you own.
    • Your mod should have a fully-detailed manifest and correctly-formatted content files to be approved.

Alternatively, if you do not wish to go through all these steps, you can message Lyrositor for him to upload the mod directly.

Once a mod is added to the repository, it can then be downloaded and applied by the mod manager at any time.

Updating

Whenever you make changes to your mod that you wish to publish, submit a new merge request with the updated files and a newer version number.

Version numbers should be of the form MAJOR.MINOR.PATCH. You should increment each number as follows:

  • MAJOR when there are big, breaking change, for any mods that might depend on this one,
  • MINOR when you add functionality that keeps the mod backwards-compatible,
  • PATCH when you add backwards-compatible bug fixes.

The requirement to adhere to these rules is not always strictly enforced, but you should try to stick to them where possible for clarity.

frangiclave-mod-repository's People

Contributors

lyrositor avatar cannibalvox avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.