Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split development info out to CONTRIBUTING.md #912

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Split development info out to CONTRIBUTING.md #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Project details/requirements

- Unity version 2022.2.15f1
- Unity URP

# Conventions

## Git

Branch naming: `kebab-case`.
Prefix the branch name with a one-word description of the purpose of the branch,
e.g. `feature/main-menu` or `fix/wall-glitch`.

## Development

⚠ The following is no longer valid as we've moved past the student project phase.

The development process is a variant of scrum structured as follows:

- 2 week long sprints
- Milestones containing 1 to 2 sprints
- Short retrospectives at the end of milestones
- Public issue-, and github-boards
- All planned tasks are converted github issues and assigned to a team member
- Public demos after ended milestones, preferably at public events
- Official releases are made after ended milestones

## Assets

Developers should strive to only use self-made assets.
This rule is in place to encourage team members to learn all aspects of game development.
The second reasoning is to keep the repository as open source as possible.

# Troubleshooting

## URP on Linux

Add `-force-vulkan` to command line arguments to avoid glitched scene view due to URP.

## Building the game

There is a bug in this Unity version that gives build errors for missing
"System.Diagnostics.Tracing". This is resolved by manually downgrading
the version in "bcl.exe.config". The dependency should be replaced with
the following:

```
<assemblyIdentity name="System.Diagnostics.Tracing" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.0.0" newVersion="4.0.0.0" />
```
54 changes: 7 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
![redplanetrampagetitlerender](https://github.com/hackerspace-ntnu/Red-Planet-Rampage/assets/54811121/e720e411-dc90-4194-94c1-c08b0e99c6f2)
![Red Planet Rampage logo](https://github.com/hackerspace-ntnu/Red-Planet-Rampage/assets/54811121/e720e411-dc90-4194-94c1-c08b0e99c6f2)

---

Red Planet Rampage is a dieselpunk western-themed arena shooter where players face off with wacky modular guns.
The game is developed by volunteers at Hackerspace NTNU and is free and open source!

*Red Planet Rampage won the "Gamer's Choice" Award at Norwegian Game Awards 2024!*
_Red Planet Rampage won the "Gamer's Choice" Award at Norwegian Game Awards 2024!_

---

Expand All @@ -20,14 +20,16 @@ The robots responsible for terraforming Mars have donned cowboy hats and started
- Splitscreen multiplayer
- Fast-paced movement

The weapon parts add even more to the mix!
The weapon parts add even more to the mix!

- Reload by playing a rhythm minigame or shaking a soda can
- Shoot bouncing cowboy hats
- Mount a frying pan at the end of your gun as a makeshift shield
- Slay your frenemies in one hit with a rubber barrel that wiggles uncontrollably
- And many more!

# Links

- The official [Steam page of Red Planet Rampage](https://store.steampowered.com/app/2717710/Red_Planet_Rampage/)
- The official [Itch.io page of Red Planet Rampage](https://hackerspace.itch.io/red-planet-rampage)

Expand All @@ -43,48 +45,6 @@ Two players shooting at each other with their unique weapons:
The auction for weapon parts:
![Gif of 2 players bidding on weapon parts](https://github.com/hackerspace-ntnu/Red-Planet-Rampage/assets/54811121/ad7fa86e-2e0b-4448-870d-b1007b97c7b9)

### Project details
- Unity version 2022.2.15f1
- Unity URP

## Conventions

### Git

Branch naming: `kebab-case`.
Prefix the branch name with a one-word description of the purpose of the branch,
e.g. `feature/main-menu` or `fix/wall-glitch`.

### Development

The development process is a variant of scrum structured as follows:
- 2 week long sprints
- Milestones containing 1 to 2 sprints
- Short retrospectives at the end of milestones
- Public issue-, and github-boards
- All planned tasks are converted github issues and assigned to a team member
- Public demos after ended milestones, preferably at public events
- Official releases are made after ended milestones

### Assets

Developers should strive to only use self-made assets.
This rule is in place to encourage team members to learn all aspects of game development.
The second reasoning is to keep the repository as open source as possible.

## Troubleshooting

### URP on Linux

Add `-force-vulkan` to command line arguments to avoid glitched scene view due to URP.

### Building the game
# Contributions

There is a bug in this Unity version that gives build errors for missing
"System.Diagnostics.Tracing". This is resolved by manually downgrading
the version in "bcl.exe.config". The dependency should be replaced with
the following:
```
<assemblyIdentity name="System.Diagnostics.Tracing" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.0.0" newVersion="4.0.0.0" />
```
If you would like to contribute to the development of Red Planet Rampage, see the [contribution guide](CONTRIBUTING.md)