RimConnect mod for RimWorld

This repository is the Mod portion of RimConnect. It contains the code that handles events and what is available for streamers to use in their game. If you want to know more about how it works as a streamer or viewer, you can check out the attached wiki articles over here

Contributing

Read the following if you're interested in adding functionality to RimConnect. If you just want to use it as a streamer or viewer, check out the wiki over here

Setup

• Install Visual Studio (your choice which version, or other IDE if you know how to setup)
• Clone project
• Create a environment variable called RIMWORLD_BASE_PATH and give it a value of your RimWorld install path. i.e D:\games\Steam\steamapps\common\RimWorld
• Open the project from source/RimConnection/RimConnection.sln
• Build using VS by hitting f6 or using build -> build Solution
• Start RimWorld normally
• Navigate to the Mods menu
• Enable the mod by ticking the red X (should become a green tick)

Running

To run RimWorld quickly, there is a quicktest parameter you can pass to the executable from a command line or through steam launch options.

• run ./RimWorldWin64 -quicktest from a console in your RimWorld folder, OR
• add -quicktest to steam launch options, instructions here

Project structure and how things hook up

There are 3 major component that make RimConnect work. The server and extension are currently private repositories.

Overview of classes

• Actions: These are the things that are actually run to make things happen in the game
• API: Functions and data classes that interact with the RimConnect server
• IncidentWorkers: New events that are custom made should go in here before being turned into an action

Useful tools and links

• https://marketplace.visualstudio.com/items?itemName=pragmatrix.BuildOnSave
  • Build the project every time you save
• Original modding tutorial setup from RimWorld wiki
  • https://rimworldwiki.com/wiki/Modding_Tutorials/Setting_up_a_solution