Skip to content

Commit

Permalink
Modified both the README and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
justinfarrelldev committed Aug 26, 2024
1 parent 2ad7a7a commit 0ec3325
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,19 +96,15 @@ Make this publicly exported
Could we make this publicly exported? We will likely consume this variable in a future update, so it would be super useful!
```

### Don't Get Mad If People Use Emojis

This one is silly, but believe it or not, I've seen it!

Emojis are perfectly okay, and I often use them myself. We may be writing code, but we shouldn't be *too* serious!
Just generally try to be kind to each other.

### No Swearing / Profanity

This should go without saying, but then again, we may have a Linux kernel contributor amongst us...

## Pipeline Courtesy

If you have recently had a pull request which failed for some reason while being merged to `main`, please attempt to remedy the pipeline. Your code was already approved, so it must be good! If you just leave it in a failed state, it has effectively wasted the code reviewer's time. If you really can't fix the pipeline by yourself, reach out to Ninjaboy on Discord.
If you have recently had a pull request which failed for some reason while being merged to `main`, please attempt to remedy the pipeline. Your code was already approved, so it must be good! If you really can't fix the pipeline by yourself, reach out to Ninjaboy on Discord.

## Use Gofmt

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Open CTP Server

[API Documentation](https://open-ctp-server.fly.dev/docs/)

## What is this?

This is the Open Call to Power Server project, or Open CTP Server for short.

This is a fan-developed server for the Call to Power series of games which intends to bring multiplayer to the franchise in a meaningful way (eventually supporting both Call to Power and Call to Power II).
This is a fan-developed server for the Call to Power series of games which intends to bring multiplayer to the franchise in a meaningful way (eventually supporting both Call to Power and Call to Power II). It is still a massive work-in-progress, as I only rarely have time to work on it. Contributions of all kinds are welcome, as long as they adhere to the guidelines outlined in `CONTRIBUTING.md` and as long as the contributions are done with other contributors in mind.

This project is **neither made nor sponsored by Activision**. See `LICENSE.md` for more details.
This project is **neither made nor sponsored by Activision**. This is a fan-made server with no affiliation to Activision. See `LICENSE.md` for more details.

## Endpoint

Expand Down Expand Up @@ -133,9 +135,7 @@ If you are trying to make a client and are struggling with using this server, fe

**This server will NOT work with either of the base, unmodified games**.

It is notable that this server will NOT function exactly the same as the vanilla CTP / CTP2 servers did, so clients will need to be modified to actually utilize this server. This will likely include a large jump in version for original-source-based repos (such as the Spyroviper Edition and Apolyton Edition) since the protobuffers target newer versions of C++ (according to [this](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md), C++ 14 or greater is required for protobuffers as protobuffers [track the Foundational C++ Support Matrix](https://protobuf.dev/support/version-support/)).

Alternatively, new clients can be coded from scratch into any protobuffer-supported language and may use this server.
It is notable that this server will NOT function exactly the same as the vanilla CTP / CTP2 servers did, so clients will need to be modified to actually utilize this server.

## Tooling

Expand Down

0 comments on commit 0ec3325

Please sign in to comment.