Skip to content

Commit 0c0e5d6

Browse files
committed
Amended readme with build instructions for Linux, credits and new extract command.
1 parent b856434 commit 0c0e5d6

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

readme.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,31 +49,32 @@ These are additional enhancements introduced here that the original game didn't
4949

5050
- Can target x86, x64 and ARM64 architectures
5151
- Support for both Microsoft Windows and Linux
52-
- Overbrights via `r_overbrights` (just be wary Anachronox's art was not designed for it!)
5352
- Higher-resolution texture replacements can be loaded in
5453
- Replacement textures need to be placed under a `hd` directory located under `anoxdata`
5554
- Can be enabled/disabled via `hd_override` cvar
5655
- Replaced QGL with GLEW
5756
- Code is compiled as C++, as opposed to C
57+
- New console variables
58+
- Overbrights via `r_overbrights` (just be wary Anachronox's art was not designed for it!)
59+
- New console commands
60+
- `extract` can be used to extract all mounted packages
5861

59-
## Wow, neat! How can I help?
62+
## Building
6063

61-
If you have experience with either C/C++, have a passion for programming and familiarity with the Anachronox game, then feel free to get in touch via our [Discord](https://discord.gg/EdmwgVk) server in the `#anachronox` channel.
64+
**(these instructions aren't necessarily up to date)**
6265

63-
Alternatively, feel free to ping me an email at [[email protected]](mailto:[email protected]).
66+
### Linux (Ubuntu 24.10)
6467

65-
## Building
68+
This is the primary platform I'm developing this on, so probably will have the best results out the gate for now.
6669

67-
**(these instructions aren't necessarily up-to-date)**
70+
1. Navigate to your cloned copy of the repo via the terminal; `cd <repo here>`
71+
2. Create a directory, then navigate into it; `mkdir build;cd build`
72+
3. Use `cmake ..` from your new directory
73+
4. Finally, use `make` and everything should just work 🤞
6874

6975
### Windows
7076

71-
#### Visual Studio
72-
73-
1. Use `vcpkg_setup_msvc.bat`; this will fetch vcpkg and install the dependencies
74-
2. Now use `cmake_generate_vs2022-x64.bat` which will generate the Visual Studio solution for you under a new `build` directory
75-
76-
#### MinGW-w64
77+
#### MinGW-w64
7778

7879
You can download MinGW-w64 from [here](https://www.mingw-w64.org/) and of course will require
7980
CMake as well which can be found [here](https://cmake.org/).
@@ -89,6 +90,18 @@ macOS support is generally going to be at the bottom of my priority list for sup
8990
1. If you don't have vcpkg installed already, use `vcpkg_setup_apple.sh`; this will fetch vcpkg and install the dependencies
9091
2. Use CMake as usual, but pass `-DCMAKE_TOOLCHAIN_FILE=vcpkg\scripts\buildsystems\vcpkg.cmake` as an argument so it can find packages provided by vcpkg
9192

93+
## Contributing
94+
95+
If you have experience with either C/C++, have a passion for programming and familiarity with the Anachronox game, then feel free to get in touch via our [Discord](https://discord.gg/EdmwgVk) server in the `#anachronox` channel.
96+
97+
Alternatively, feel free to ping me an email at [[email protected]](mailto:[email protected]).
98+
99+
## Credits
100+
101+
Incorporates some additional bug fixes sourced from...
102+
- KMQuake2
103+
- Paril
104+
92105
## Resources
93106

94107
- [Anachrodox](https://anachrodox.talonbrave.info/)

0 commit comments

Comments
 (0)