Documentation

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: jorio

BUILD.md

@@ -0,0 +1,67 @@
+# How to build Cro-Mag Rally
+
+## TL;DR: Automated build script
+
+Clone the repo **recursively**, then run `python3 build.py` to execute the build steps described in this document and package up the game.
+
+build.py is the script that is used by the CI setup to produce builds. If you want to build the game manually instead, read on.
+
+## How to build the game on macOS
+
+1. Install the prerequisites:
+    - Xcode 12+
+    - [CMake](https://formulae.brew.sh/formula/cmake) 3.16+
+1. Clone the repo **recursively**:
+    ```
+    git clone --recurse-submodules https://github.com/jorio/CroMagRally
+    ```
+1. Download [SDL2-2.0.22.dmg](https://libsdl.org/release/SDL2-2.0.22.dmg), open it, and copy **SDL2.framework** to the **extern** folder
+1. Prep the Xcode project:
+    ```
+    cmake -G Xcode -S . -B build
+    ```
+1. Now you can open `build/CroMagRally.xcodeproj` in Xcode, or you can just go ahead and build the game:
+    ```
+    cmake --build build --config RelWithDebInfo
+    ```
+1. The game gets built in `build/RelWithDebInfo/CroMagRally.app`. Enjoy!
+
+## How to build the game on Windows
+
+1. Install the prerequisites:
+    - Visual Studio 2022 with the C++ toolchain
+    - [CMake](https://cmake.org/download/) 3.16+
+1. Clone the repo **recursively**:
+    ```
+    git clone --recurse-submodules https://github.com/jorio/CroMagRally
+    ```
+1. Download [SDL2-devel-2.0.22-VC.zip](https://libsdl.org/release/SDL2-devel-2.0.22-VC.zip) and extract the contents into the **extern** folder
+1. Prep the Visual Studio solution:
+    ```
+    cmake -G "Visual Studio 17 2022" -A x64 -S . -B build
+    ```
+1. Now you can open `build/CroMagRally.sln` in Visual Studio, or you can just go ahead and build the game:
+    ```
+    cmake --build build --config Release
+    ```
+1. The game gets built in `build/Release/CroMagRally.exe`. Enjoy!
+
+## How to build the game on Linux et al.
+
+1. Install the prerequisites from your package manager:
+    - Any C++20 compiler
+    - CMake 3.16+
+    - SDL2 development library (e.g. "libsdl2-dev" on Ubuntu, "sdl2" on Arch, "SDL-devel" on Fedora)
+    - OpenGL development libraries (e.g. "libgl1-mesa-dev" on Ubuntu)
+1. Clone the repo **recursively**:
+    ```
+    git clone --recurse-submodules https://github.com/jorio/CroMagRally
+    ```
+1. Build the game:
+    ```
+    cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo
+    cmake --build build
+    ```
+    If you'd like to enable runtime sanitizers, append `-DSANITIZE=1` to the **first** `cmake` call above.
+1. The game gets built in `build/Release/CroMagRally`. Enjoy!
+

CHANGELOG.md

@@ -1,3 +1,45 @@
 # Cro-Mag Rally Changelog
 
-## 3.0.0 - TBA
+- **3.0.0 (June 27, 2022)**
+    - Initial playable release of the modern source port
+    - A ton of new stuff in this version!!
+        - Up to 4 players in split-screen multiplayer (up from 2 in the original)
+        - The UI has been tweaked to be pleasant to look at on modern widescreens
+        - UI elements are subtly animated
+        - The physics editor got a graphical overhaul
+        - You can enable a timer in race modes to hone your racing skills
+        - Keep track of your race records in the all-new scoreboard
+        - Tired of wearing brown leopard skin all the time? Change your outfit in the character select screen (press up/down)
+        - The font is now proportional (easier to read) and contains accented characters for all languages supported by the game
+    - Minor gameplay fixes, including:
+        - Throw a weapon and pick up another powerup in quick succession
+        - Better fence collisions
+    - Please note that NetSprockets multiplayer from the OS 9 version is still missing. It may be recreated in a later update if there's interest for it.
+
+This port is provided free of charge! If you'd like to support the development of Pangea game ports, you can visit https://jorio.itch.io and name your own price for any of the games there. Much appreciated!
+
+---
+
+- **2.2.1 (May 5, 2006)**: Fix QuickTime 7 issue. Last version for PowerPC Macs.
+
+- **2.2 (November 3, 2003)**: Fix crash on Jaguar and Panther
+
+- **2.1.2 (June 6, 2003)**: Fix Open Transport issues
+
+- **2.1 (August 16, 2002)**: Maintenance update, automatic version checking
+
+- **2.0.4 (April 11, 2002)**: Shareware version
+
+- **2.03 (March 26, 2002)**: OS X fixes
+
+- **2.02 (December 14, 2001)**: OS X fixes
+
+- **2.01c (September 28, 2001)**: OS X fixes
+
+- **2.0b4 (May 17, 2001)**
+
+- **2.0b1 (March 27, 2001)**: Carbonized (OS X support). 
+
+- **1.0.5 (December 4, 2000)**: Physics editor, Simplistic difficulty level
+
+- **1.0 (November 2000?)**: Initial release

README.md

@@ -1 +1,47 @@
 # Cro-Mag Rally
+
+## *The wildest racing game since man invented the wheel!*
+
+This is a port of Pangea Software’s racing game **Cro-Mag Rally** to modern operating systems.
+
+**Download the game for macOS, Windows and Linux here:** https://github.com/jorio/CroMagRally/releases
+
+![Cro-Mag Rally Screenshot](docs/screenshot.webp)
+
+## About Cro-Mag Rally
+
+> In Cro-Mag Rally you are a speed-hungry caveman named Brog who races through the Stone, Bronze, and Iron Ages in primitive vehicles such as the Geode Cruiser, Bone Buggy, Logmobile, Trojan Horse, and many others. Brog has at his disposal an arsenal of primitive weaponry ranging from Bone Bombs to Chinese Bottle Rockets and Heat Seeking Homing Pigeons.
+> 
+> In addition to single-player racing where one player races against the computer, there are also several different multi-player modes including Tag, Capture the Flag, and Survival. Up to four players can play on a single computer in split-screen mode.
+
+CMR was released in 2000 by Pangea Software as a Mac exclusive, and it was a pack-in game on Macs that came out around that time.
+
+## About this port
+
+This is a port of the original OS 9 version of the game. It aims to provide the best way to experience CMR on today’s computers. It is an “enhanced” version insofar as it fixes bugs that may hinder the experience, and it brings in a few new features in keeping with the spirit of the original game.
+
+Some of the new features include:
+- Up to 4 players in split-screen multiplayer (up from 2 in the original).
+- The UI is subtly animated and has been tweaked to be pleasant to look at on modern widescreens.
+- Enable a timer in race modes to hone your racing skills, and keep track of your records in the all-new scoreboard!
+
+I haven’t had time to restore NetSprockets multiplayer from the OS 9 version yet, but that may come in a later release.
+
+### More documentation
+
+- [BUILD](BUILD.md) – How to build the game from source
+- [CHANGELOG](CHANGELOG.md) – Cro-Mag Rally version history
+- [LICENSE](LICENSE.md) – Licensing info (see also below)
+- [SECRETS](SECRETS.md) – Cheat codes!
+
+### Legal info
+
+Cro-Mag Rally © 2000 Pangea Software, Inc. Cro-Mag Rally is a trademark of Pangea Software, Inc. This version was made and re-released here (https://github.com/jorio/CroMagRally) under permission from Pangea Software, Inc.
+
+This version is licensed under [CC-BY-NC SA 4.0](LICENSE.md).
+
+## More Pangea stuff!
+
+Check out my ports of [Bugdom](https://github.com/jorio/Bugdom), [Nanosaur](https://github.com/jorio/Nanosaur), [Mighty Mike (Power Pete)](https://github.com/jorio/MightyMike) and [Otto Matic](https://github.com/jorio/OttoMatic).
+
+All ports are free of charge! If you’d like to support the development of Pangea game ports, feel free to visit https://jorio.itch.io and name your own price for any of the games there. Much appreciated! 😊

SECRETS.md

@@ -1,14 +1,14 @@
 # Cro-Mag Rally secrets
 
-Screen            | Keys       | What will happen                               
-------------------|------------|------------------------------------------------
-Any               | `F8`       | Cycle through 3 debug modes                    
-Main menu page 1  | `F1`       | Initiate self-running demo                     
-Character select  | `↑` or `↓` | Swap skins                              
-Track select      |`B`+`R`+`I`*| Enter locked track                             
-Vehicle select    |`B`+`R`+`I`*| Use locked car                                 
-In-game           |`B`+`R`+`I`*| Win race (your time won't be saved)
-In-game           |`L`+`A`+`P` | Skip lap
-Main menu page 1  |`B`+`R`+`I`*| Set tournament progression to 100%                  
+| Screen           | Keys         | What will happen                    |
+|------------------|--------------|-------------------------------------|
+| Any              | `F8`         | Cycle through 3 debug modes         |
+| Main menu page 1 | `F1`         | Initiate self-running demo          |
+| Character select | `↑` or `↓`   | Swap skins                          |
+| Track select     | `B`+`R`+`I`* | Enter locked track                  |
+| Vehicle select   | `B`+`R`+`I`* | Use locked car                      |
+| In-game          | `B`+`R`+`I`* | Win race (your time won't be saved) |
+| In-game          | `L`+`A`+`P`  | Skip lap                            |
+| Main menu page 1 | `B`+`R`+`I`* | Set tournament progression to 100%  |
 
 \* If your keyboard has trouble registering the B-R-I keys simultaneously, you can try C-M-R instead.

build.py

@@ -239,7 +239,7 @@ def copy_documentation(proj, appdir, full=True):
     if full:
         shutil.copytree("docs", F"{appdir}/Documentation")
         os.remove(F"{appdir}/Documentation/screenshot.webp")
-        for docfile in ["CHANGELOG.md"]:
+        for docfile in ["CHANGELOG.md", "SECRETS.md"]:
             shutil.copy(docfile, F"{appdir}/Documentation")
 
 def package_windows(proj: Project):

extern/README.md

@@ -0,0 +1 @@
+External libraries go here (Pomme, SDL)

packaging/ReadMe.txt.in

@@ -3,3 +3,7 @@ Cro-Mag Rally @PROJECT_VERSION@
 
 Visit https://pangeasoft.net for the original makers of the game,
 or https://github.com/jorio/cromagrally for information about this updated version.
+
+This port is provided free of charge! If you'd like to support the development of
+Pangea game ports, feel free to visit https://jorio.itch.io and name your own price
+for any of the games there. Much appreciated! :)