Skip to content

Commit

Permalink
Added contribution instructions. Fixes naelstrof#100
Browse files Browse the repository at this point in the history
  • Loading branch information
naelstrof committed Jan 3, 2023
1 parent 871086c commit 5115bff
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 25 deletions.
19 changes: 0 additions & 19 deletions COMPILING.md

This file was deleted.

33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

If you want to contribute to KoboldKare, first you'll want to make an issue describing the thing you want to change.
A moderator should respond to help collaborate and contribute to making the change happen.

After that, in order to contribute to KoboldKare, you just need to do the following:
- Fork the project.
- Make the change.
- Submit a pull request.

You can read more about how this is done here: https://docs.github.com/en/get-started/quickstart/fork-a-repo

# Installing and Editing KoboldKare

1. Install git. If you're on modern windows, you can use the `winget` package manager for this:
![winget example image](winget_install.png)
Just install it by typing `winget install Git.Git` into a powershell or cmd.
2. Install blender. Funnily enough this is *also* in the windows package manager. You can install it with `winget install BlenderFoundation.Blender`.
3. Install UnityHub, winget has this available as: `winget install UnityTechnologies.UnityHub`
4. Download the KoboldKare's version of Unity. As of this commit it is 2021.3.6f1, which you can download by putting this link into a browser: [unityhub://2021.3.6f1/7da38d85baf6](unityhub://2021.3.6f1/7da38d85baf6)
5. Restart the computer. This is important if you've just installed git. As you need to make sure the git executable is in your path **before** you try to open the project.
6. Clone the KoboldKare repository. This can be done with something like Github Desktop. You'll want to clone *your* fork of KoboldKare, so that you'll have access to push commits.
7. Open the KoboldKare folder with UnityHub. It should now import correctly!

This is all you need to do to open, edit, and test KoboldKare.

# Building

You do not need to build KoboldKare to make changes, though to prevent questions-- here's how to build KoboldKare when you get to it.
You first need to build addressables.
You can find instructions on that here: https://docs.unity3d.com/Packages/[email protected]/manual/Builds.html

After that you can build normally (File->Build Settings->Build). Do not run the KoboldKare continuous integration builders found in the KoboldKare->Build menus.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,4 @@ Please read [LICENSE](LICENSE) to ensure you have license to do what you want wi

## Contributing

This repository is currently in shambles and is being fixed as you read this!
TODO: fill out contributing stuff here

## Attributions

You can find a list of assets, their authors, and their licenses within [Attributions.txt](Attributions.txt)
You can learn how to contribute to KoboldKare by reading [CONTRIBUTING.md](CONTRIBUTING.md)

0 comments on commit 5115bff

Please sign in to comment.