Skip to content

Commit

Permalink
Repo Update
Browse files Browse the repository at this point in the history
Just making it up to par with the previous repo.
  • Loading branch information
SweptWasTaken authored Jan 10, 2020
1 parent 60151dc commit 2915445
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 4 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing

## Pulling the project

To pull the project, issue these commands in the git bash shell:

```bash
cd "/c/Program Files (x86)/Steam/steamapps/common/RimWorld/Mods"
git clone git@github.com:rwmt/Multiplayer.git
```

If your RimWorld installation is in a non-standard location, cd to that `Mods` directory first before cloning.

## Building the Multiplayer mod

Once you've got your assemblies in the correct spots, you can open up the `Source/Multiplayer.sln` file in your IDE of choice and press `ctl-shift-b` to build the assemblies. You should now have a debug version of the Multiplayer mod.

## Completing an issue

You're now ready to start an issue. Assign yourself to the issue you want to complete and make a branch for it. Please include the number of the issue in the branch name for easy traceability of feature branches (Example: `issue-9-feature`). Complete the feature and test thoroughly before making your PR.

Please prefix all commit messages in your PR with `#{issue_number}` to help with auto-linking to issue (Example `#9: create initial contributors document`).

## Making a PR

Make a PR to commit your code to the development branch. At this point, at least two reviewers needs to sign off before the code can be merged. They may also have comments or requests for changes. Please work with the reviewer until they are satisfied. Once the approval is given, merge your branch via the `Squash and Merge` merge method.

## More Information

For more documentation, please go to the Dev Wiki linked in the readme of this repo.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# Multiplayer
Multiplayer mod for RimWorld

Thanks to Pardeike for making [Harmony](https://github.com/pardeike/Harmony) and RevenantX for creating [LiteNetLib](https://github.com/RevenantX/LiteNetLib)
# Rimworld Multiplayer
Originally created by Zetrith, The Rimworld Multiplayer Mod is now being updated and maintained by community members. The original git repo is deprecated and will not receive any updates.

Please do all pull requests to the development branch

Steam Workshop Link : https://steamcommunity.com/sharedfiles/filedetails/?id=1752864297

Join the Discord : https://discord.gg/S4bxXpv

[Git Releases ](https://github.com/rwmt/Multiplayer/releases)|
[ Installation ](https://hackmd.io/Gd_gueokTNui_fqzOSG2Tg#Installation)|
[ Hosting ](https://hackmd.io/Gd_gueokTNui_fqzOSG2Tg#Hosting-and-Joining)|
[ FAQ ](https://hackmd.io/Gd_gueokTNui_fqzOSG2Tg#FAQ)|
[ Contributing ](https://github.com/rwmt/Multiplayer/blob/master/CONTRIBUTORS.md)|
[ DEV Wiki](https://hackmd.io/Gd_gueokTNui_fqzOSG2Tg#Dev-MP-Wiki)

Thanks to Pardeike for making [Harmony](https://github.com/pardeike/Harmony) and RevenantX for creating [LiteNetLib](https://github.com/RevenantX/LiteNetLib)

0 comments on commit 2915445

Please sign in to comment.