vera/nuclide
4
0
Fork 0
Code Issues 32 Pull requests Projects Releases Packages Activity

Added a 'doc' sub-dir, starting with minor documentation regarding building, FAQ

Browse source
This commit is contained in:
Marco Hladik 2020-05-27 10:12:09 +02:00
parent fe251faf81
commit 68669fb701
2 changed files with 51 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/building Normal file
View file

@ -0,0 +1,27 @@
1. Building all of the game-logic
To build the game-logic for all games, issue 'make' inside the src/
directory of the repository. This requires you to have the latest
fteqcc installed.
2. Building a specific game or mod
For that you'll have to navigate into the client and server directory
of the game you want to compile. For example if you're only wanting to
build the Half-Life game-logic, navigate into src/client/valve, issue
'make' there, then do the same inside src/server/valve.
3. Building the engine
The engine is not part of this project.
However, as of this writing, building the engine is simple.
Checkout/Clone the FTEQW engine repository, then navigate into the
engine/ sub-directory and issue 'make m-rel' there.
This will generate a 'fteqw' binary for your platform in the sub-directory
titled 'release'.
4. Misc notes
To those not in the know, the game-logic is written in QuakeC, it is thus
platform and architecture independent. You do not need to rebuild the logic
for each and every platform. The result will be identical.

28
faq → doc/faq
View file

@ -1,20 +1,31 @@
Q: Why does this project exist?
A: >I< wanted a free variant of the best version of Counter-Strike in 2016 as
A: I wanted a free variant of the best version of Counter-Strike in 2016 as
as I was preparing to move away from x86 hardware and moving to other
operating systems that could never run Wine/Windows software.
So I decided to 'put my money where my mouth is' and write a small
game-logic re-implementation of CS. It grew from there.
In the end, I aim to support more mods. Including Half-Life.
A lot of the codebase I also use in my commercial game, The Wastes.
Due to the free license on this codebase, so can you.
Q: Can I help at this moment?
A: Not really. Unless you've got crashes etc. to report that are really bad
A: It depends. If you've got crashes etc. to report that are really bad
and not documented, feel free to report them. I know what needs doing and
it'll get done in time.
But then there's little things, like - getting the firing rate of a weapon
just right. I do not look at decompiled code. I do not look at leaked code.
if you can research the exact values of some low-hanging fruit like that,
feel free to tweak the values and send me a diff or tell me what needs to be
changed on IRC.
If a crash to console happens, it's most likely my bug. If the whole engine
comes crashing down, it's FTEQW's fault. Not mine.
Q: It doesn't work with my Half-Life/Counter-Strike version.
A: This is designed for the disc version of Half-Life, released before Steam.
Supporting both is a bit annoying right now. I might add support for the
Steam UI one day.
Steam UI one day. Just right now it's in an alpha-stage where yes, most DOES
work, the backend is constantly changing still and I can't afford to support
all these things at once.
Q: I don't like how you're doing [insert thing here]!
A: Too bad!
@ -45,15 +56,24 @@ Q: X#sh3D? Why not use that instead of FTE QuakeWorld?
A: There are enough GPL violators around, I do not need to contribute to that
cesspool. 'From scratch' my a$$.
Q: Is FTEQW a GoldSrc replacement?
A: No. It is not aiming to be anything like that. FTE has been around for
longer (in parts) than even GoldSrc has. It's just a QuakeWorld engine
that supports an whole lot of formats.
You can easily make very modern games with it too. It's not limited like
GoldSrc and Source in terms of rendering as it's fully accessible.
Q: [insert thing here] isn't 100% exact as in the original 1.5.
A: Sometimes bugs get fixed, sometimes very minor details get streamlined in
order to get more work done in other areas. FreeCS will most likely never
be done in that accuracy aspect, but it'll get better with time.
Feel free to contribute when it comes to low-hanging fruit like tweaking
variables!
Q: Why do this when you can just run a VM?
A: FreeCS isn't just making CS more portable. It also fixes bugs. It optimises
the netcode greatly. It's got much better lag compensation and client-side
player and weapon prediction than CS ever did.
player and weapon prediction than CS ever did. Yes, even the Steam version.
Q: I still don't get it - why not play CS on Steam?
A: This is clearly not intended for you, then!