Skip to content
This repository was archived by the owner on Jan 5, 2024. It is now read-only.

Commit a87ae03

Browse files
committed
Update readme and gitignore
1 parent 4c8bf79 commit a87ae03

File tree

2 files changed

+39
-33
lines changed

2 files changed

+39
-33
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ compile_commands.json
1717
/NATPunchServer/Server/NATCompleteServer/Release
1818
/Documentation/Doxygen/Output
1919
MemCleanupInfo.txt
20+
RTEA.vcxproj.user

README.md

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,44 @@
1-
# Cortex Command Community Project Source #
1+
# Cortex Command Community Project Source
22
*The Cortex Command Community Project is Free/Libre and Open Source under GNU AGPL v3*
33

4-
This is a community-driven effort to continue the development of Cortex Command. Stay up to date in our [discord channel](https://discord.gg/SdNnKJN).
4+
This is a community-driven effort to continue the development of Cortex Command.
5+
Stay up to date in our [Discord channel](https://discord.gg/SdNnKJN).
56

67
***
78

8-
## Setup Process ##
9-
9+
# Windows Build Instructions
1010
First you need to download the necessary files:
1111

1212
1. Install the necessary tools.
13-
You'll probably want [Visual Studio Community Edition](https://visualstudio.microsoft.com/downloads/) (we mostly use 2017 but 2019 should be fine).
13+
You'll probably want [Visual Studio Community Edition](https://visualstudio.microsoft.com/downloads/) (build supports both 2017 and 2019 versions).
1414
You also need to have [Visual C++ Redistributable for Visual Studio 2017 (x86)](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) installed in order to run the compiled builds.
1515
You may also want to check out the list of recommended Visual Studio plugins [here](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/wiki/Information,-Recommended-Plugins-and-Useful-Links).
1616

1717
2. Clone this Source Repository and the [Data Repository](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Data) in neighboring folders.
1818
**Do Not** change the folder names unless you want to make trouble for yourself.
1919

20-
3. Copy the following libraries from `Cortex-Command-Community-Project-Source\external\lib\` into the Data Repository:
20+
3. Copy the following libraries from `Cortex-Command-Community-Project-Source\external\lib\` into the **Data Repository**:
2121
* `lua51.dll`
2222
* `fmod.dll`
2323
* `liblz4.dll`
2424
* `zlibwapi.dll`
2525

26-
4. Copy `Scenes.rte` and `Metagames.rte` from your purchased copy of Cortex Command into the Data Repository.
26+
4. Copy `Scenes.rte` and `Metagames.rte` from your purchased copy of Cortex Command into the **Data Repository**.
2727

2828
Now you're ready to build and launch the game.
2929
Simply open `RTEA.sln` with Visual Studio, choose your configuration, and run the project.
3030

31-
* Use "`Debug Open Source`" configuration to debug (this runs very slowly)
32-
* Use "`Minimal Debug Open Source`" configuration to debug with all visual debug elements disabled (this runs slightly faster)
33-
* Use "`Final Open Source`" configuration to build release .exe
31+
* Use `Debug Full` for debugging with all visual elements enabled (builds fast, runs very slow).
32+
* Use `Debug Minimal` for debugging with all visual elements disabled (builds fast, runs slightly faster).
33+
* Use `Debug Release` for a debugger-enabled release build (builds slow, runs almost as fast as Final).
34+
* Use `Final` to build release executable.
3435

3536
The first build will take a while, but future ones should be quicker.
3637

37-
## Linux Build Instructions ##
38+
# Linux Build Instructions
3839
The Linux build uses the meson build system, and builds against system libraries
3940

40-
Dependencies:
41+
### Dependencies:
4142

4243
* `g++>=8.1` (needs to support c++17 filesystem)
4344
* `allegro4`
@@ -52,43 +53,39 @@ Dependencies:
5253
* `boost>=1.55`
5354
* `xorg-misc-fonts`
5455

55-
Building:
56+
### Building:
5657

57-
1. Install Dependencies (see below for some distro-specific instructions)
58+
1. Install Dependencies (see below for some distro-specific instructions).
5859

5960
2. Clone this Source Repository and the [Data Respository](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Data)
6061

61-
3. open a terminal in the Source Repository
62+
3. Open a terminal in the Source Repository.
6263

6364
4. `meson builddir`
6465

6566
5. `cd builddir`
6667

67-
For `meson` versions `>=0.54` (check `meson --version`):
68+
For `meson` versions `>=0.54` (check `meson --version`) :
6869

69-
6. `meson compile` for debug build, or `meson compile CCCP` for a release build. If the build fails because of memory shortage you may need to reduce the number of build threads (meson will use all available threads by default) using the `-j<number of threads>` option, if this doesn't help increase your swap size to at least 6Gb
70+
6. `meson compile` for debug build, or `meson compile CCCP` for a release build.
71+
If the build fails because of memory shortage you may need to reduce the number of build threads (meson will use all available threads by default) using the `-j<number of threads>` option, if this doesn't help increase your swap size to at least 6Gb.
7072

7173
For `meson` versions `<0.54`
7274

73-
6. `ninja` for debug builds, or `ninja CCCP.x86_64` for release builds. Using the `-j<number of threads>` option will also work here.
74-
75-
76-
Running:
75+
6. `ninja` for debug builds, or `ninja CCCP.x86_64` for release builds.
76+
Using the `-j<number of threads>` option will also work here.
7777

78-
1. Copy (or link, might be preferable for testing builds) `builddir/CCCP_debug.x86_64` or `builddir/CCCP.x86_64` (depending on if you made a release build) into the **Data Repository**
78+
### Running:
7979

80-
2. Copy `Scenes.rte` and `Metagames.rte` from your purchased copy of Cortex Command into **Data Repository**
80+
1. Copy (or link, might be preferable for testing builds) `builddir/CCCP_debug.x86_64` or `builddir/CCCP.x86_64` (depending on if you made a release build) into the **Data Repository**.
8181

82-
3. Run `./CCCP.x86_64` or `./CCCP_debug.x86_64` in the **Data Repository**
82+
2. Copy `Scenes.rte` and `Metagames.rte` from your purchased copy of Cortex Command into **Data Repository**.
8383

84-
### Arch Linux ###
85-
`# pacman -S allegro4 flac luajit minizip lz4 libpng libx11 meson xorg-fonts-misc`
86-
87-
### Ubuntu ###
88-
`# apt-get install liballegro4-dev libloadpng4-dev libflac++-dev luajit-5.1-dev libminizip-dev liblz4-dev libpng++-dev libx11-dev meson`
84+
3. Run `./CCCP.x86_64` or `./CCCP_debug.x86_64` in the **Data Repository**.
8985

90-
### Troubleshooting ###
91-
Until borderless windows are implemented, you might seem get stuck in fullscreen mode. Try Alt-Return, or if that doesn't work kill CC with ctrl-alt-end.
86+
### Troubleshooting:
87+
Until borderless windows are implemented, you might seem get stuck in fullscreen mode.
88+
Try Alt-Return, or if that doesn't work kill CC with ctrl-alt-end.
9289

9390
On X11 media keys and such don't work in fullscreen, this is a known issue (this does not happen on Wayland).
9491

@@ -99,6 +96,14 @@ option snd_intel_hda index=1
9996
```
10097
to `/etc/modprobe.d/alsa-base.conf`
10198

102-
## More Information ##
99+
***
100+
101+
**Arch Linux:**
102+
`# pacman -S allegro4 flac luajit minizip lz4 libpng libx11 meson xorg-fonts-misc`
103+
104+
**Ubuntu:**
105+
`# apt-get install liballegro4-dev libloadpng4-dev libflac++-dev luajit-5.1-dev libminizip-dev liblz4-dev libpng++-dev libx11-dev meson`
106+
107+
## More Information
103108

104-
For more information and recommendations, see [here](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/wiki/Information,-Recommended-Plugins-and-Useful-Links).
109+
For more information and recommendations, see [here](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/wiki/Information,-Recommended-Plugins-and-Useful-Links).

0 commit comments

Comments
 (0)