All Projects → n-fisher → cookiecutter-rimworld-mod-development

n-fisher / cookiecutter-rimworld-mod-development

Licence: MIT License
A cookiecutter project that builds the basic Rimworld mod development file structure and build environment.

Programming Languages

C#
18002 projects

Projects that are alternatives of or similar to cookiecutter-rimworld-mod-development

PrisonLabor
Prison Labor mod for RimWorld game
Stars: ✭ 39 (-33.9%)
Mutual labels:  mod, rimworld
Bubbles
Shows bubbles for social interactions.
Stars: ✭ 17 (-71.19%)
Mutual labels:  mod, rimworld
Phi
Phi is a Rimworld mod that enables multiplayer interactions between players
Stars: ✭ 51 (-13.56%)
Mutual labels:  mod, rimworld
cookiedozer
📱 Cookiecutter for i18n Kivy Apps
Stars: ✭ 48 (-18.64%)
Mutual labels:  cookiecutter-template
xrns2xmod
Xrns2XMOD is a Renoise to MOD / XM format converter
Stars: ✭ 20 (-66.1%)
Mutual labels:  mod
KK
Koikatu遊戲外掛。 (Unity Game Plugins) https://blog.maki0419.com/2020/05/personal-koikatu-plugin.html
Stars: ✭ 40 (-32.2%)
Mutual labels:  mod
TheseusServices
Private Military Company content mod for Arma 3
Stars: ✭ 16 (-72.88%)
Mutual labels:  mod
Fabric-Autoswitch
Automagical switching of tools to the best one for the job, for Minecraft
Stars: ✭ 17 (-71.19%)
Mutual labels:  mod
JecsTools
Adds modding components to RimWorld: vehicles, spell casting, weapon slots, oversized weapons, and more!
Stars: ✭ 17 (-71.19%)
Mutual labels:  rimworld
Allomancy
Brandon Sanderson's Allomancy, now in Minecraft
Stars: ✭ 18 (-69.49%)
Mutual labels:  mod
ml mods
MelonLoader mods for VRChat
Stars: ✭ 40 (-32.2%)
Mutual labels:  mod
m-microcontroller
Factorio mod: program circuit network logic using FAL, a Factorio Assembly Language.
Stars: ✭ 13 (-77.97%)
Mutual labels:  mod
cookiecutter-homeassistant-component
A cookiecutter project template for generating the structure for a new custom component.
Stars: ✭ 22 (-62.71%)
Mutual labels:  cookiecutter-template
CrowdedSheriff
BepInEx mod adding custom Sheriff role in the "Among Us" game
Stars: ✭ 15 (-74.58%)
Mutual labels:  mod
d2
A d2 mod for OpenRA
Stars: ✭ 44 (-25.42%)
Mutual labels:  mod
observable
See what's lagging your server. 1.5M+ downloads on CurseForge
Stars: ✭ 22 (-62.71%)
Mutual labels:  mod
BTD6-Mods
doombubbles' BTD6 Mods, powered by BTD Mod Helper
Stars: ✭ 19 (-67.8%)
Mutual labels:  mod
guardian
A free, open-source, and feature-rich modification for the Attack on Titan Tribute Game (AoTTG).
Stars: ✭ 12 (-79.66%)
Mutual labels:  mod
MindustryClassicified
MindustryClassicified :: A Mindustry mod to return the graphics to 3.5
Stars: ✭ 15 (-74.58%)
Mutual labels:  mod
FrogCraft-Rebirth
A standalone rewrite of FrogCraft, an IC2 Addon with theme of chemical industry, starting from scratch.
Stars: ✭ 27 (-54.24%)
Mutual labels:  mod

cookiecutter-rimworld-mod-development

A cookiecutter project that builds the basic Rimworld mod development file structure and sets up a sane build environment.

Table of Contents

Install/Setup

Windows Command Prompt

Required Programs
Usage (inside Rimworld/Mods folder)
  1. cookiecutter gh:n-fisher/cookiecutter-rimworld-mod-development
  2. Follow the prompts, and just press enter to skip the last prompt (_visual_studio)
  3. Open the folder you just created and double-click the ModName.sln file
  4. In the Solution Explorer pane right click RimWorldWin and click Set as Startup Project

Microsoft Visual Studio Integration

Required Programs
Install (if no File -> New -> From Cookiecutter... option is available)
  1. Open up VS Installer (In Visual Studio -> Tools -> Gets Tools and Features)
  2. Click Modify
  3. Click Individual Components
  4. Scroll to Development activities 5a. (VS 2017) Click the Cookiecutter template support checkbox 5b. (VS 2019) Click the Python language support checkbox
  5. Click Modify
Usage

(Due to a bug in VS, you'll have to make the specific mod's folder in [...]/Rimworld/Mods/ModName beforehand)

  1. Open Visual Studio
  2. File -> New -> From Cookiecutter...
  3. Search for rimworld
  4. Double-click n-fisher/cookiecutter-rimworld-mod-development
  5. Change the Template Options:
    • Create To => [...]/Rimworld/Mods/mod_name
    • Mod name
    • Author (Use your Steam username for automatic linking of mod to profile) (can change later in About.xml)
    • Mod Description (not required, can change later in About.xml)
    • Create blank XML files (yes/no)
  6. Create and Open Folder
  7. In the Solution Explorer pane double click your ModName.sln file

Basic Features

Folder Structure

This cookiecutter builds the entire standard mod folder structure, with empty folders as the default. namespace_name is automatically calculated.

  • {{cookiecutter.mod_name}}
    • About
      • About.xml
      • Preview.png
    • Common
      • Assemblies
      • Defs
      • Languages
      • Patches
      • Sounds
      • Textures
    • Source
      • Properties
        • AssemblyInfo.cs
      • namespace_name.cs
      • namespace_name.csproj
      • namespace_name.csproj.user
    • namespace_name.sln
    • LoadFolders.xml

VS Setup Automation

  • Links Rimworld and UnityEngine .dlls for importing in code
  • Clears the default set debugging and trace constants
  • Creates a VS solution with correctly defined paths
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].