From ba81bcba699cf7793603d9d4712e0c4b3045ab5b Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Sat, 22 Nov 2014 04:21:15 +1100 Subject: [PATCH] Added a README for the demo build --- README.txt | 34 ++++++++++++++++++++++++++++++++++ makefile | 2 +- 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 README.txt diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..714ef55 --- /dev/null +++ b/README.txt @@ -0,0 +1,34 @@ +This is the README for Tortuga's demo build. The source code is available at: + + https://github.com/Ratstail91/Tortuga + +The current build may have bugs, missing features, bugs masquerading as +features, etc. You can report a bug/feature here: + + https://github.com/Ratstail91/Tortuga/issues + +Please note that this game requires a functioning server to operate correctly. +Both a game server and game client are included in this package. + +------------------------- +Instructions For Setup +------------------------- + +1. To create a server, simply run server.exe. +2. To join that server, run client.exe with config settings not already in use. + (Note: This process will be streamlined later). +3. To change the config settings, open rsc/config.cfg +4. These settings must be unique for each player: + +* client.username +* client.handle + +5. There are currently two options for 'client.avatar': + +* client.avatar = elliot2.bmp #male +* client.avatar = coa2.bmp #female + +6. When you've correctly set these values (good luck), select 'Start' from the + main menu; this displays the list of available servers. +7. Select the name of your server (default is 'local') and select 'Join'. +8. Welcome to Tortuga, enjoy your stay. diff --git a/makefile b/makefile index 7b66127..8e55ca3 100644 --- a/makefile +++ b/makefile @@ -19,7 +19,7 @@ release: clean all package #For use on my machine ONLY package: rar a -r -ep Tortuga.rar $(OUTDIR)/*.exe $(OUTDIR)/*.dll - rar a -r Tortuga.rar rsc/* copyright.txt + rar a -r Tortuga.rar rsc/* copyright.txt README.txt $(OUTDIR): mkdir $(OUTDIR)