diff --git a/install.md b/install.md new file mode 100644 index 0000000..b37388f --- /dev/null +++ b/install.md @@ -0,0 +1,18 @@ +## Installing +Usually, a package comes with binaries pre-compiled for Windows. Thus, all you have to do is extract the package that Nu Replayer and its assets were in, and you are all set. Nu Replayer has been tested on Windows XP through 11. It has been compiled using FreeBASIC 1.09.0. + +To build new Windows binaries isn't *that* difficult, but you'll need to install additional libraries to ensure proper linking. Afterwards, just type in `fbc NuReplay.bas NuReplay.rc -s gui` in a command shell, or use an IDE able to pass that command. + +### Common Libraries +Regardless of platform, you will likely need to install additional libraries, notably runtime and/or development variants of SDL, SDL_mixer, SDL_net, zlib, and libzip. + +### GNU/Linux +Installing under GNU/Linux, on the other hand, is not so simple. Since the architecture for this system is all over the place, no binaries are provided for GNU/Linux, so you must compile from the included source. Furthermore, FreeBASIC has not been seen in any package manager, so you will likely need to download it directly from the [developer website](http://www.freebasic.net) and follow its installation instructions. A simple makefile is supplied. + +### FreeBSD +FreeBSD support was added in FreeBASIC 1.09.0. We presume instructions are similiar to GNU/Linux, but this is untested. Feel free to experiment as need be, until you are able to build your own program. + +### Wine +Alternatively, if you can figure out how to use [Wine](http://www.winehq.org/), then you can use it to run the pre-compiled Windows binaries. This is likely the only way to run Nu Replayer outside of the systems above, as FreeBASIC compiler tools are not provided for any other platforms (except DOS). + +That being said, it *might* be remotely possible to compile a native DOS build, but this is extremely tricky to pull off, and is impossible to cross-compile from a 64-bit Windows system. Nu Replayer also does not currently comply with the 8.3 filename system. To summarize, building for DOS is untested. diff --git a/readme.md b/readme.md index 42c00c9..b92c930 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,13 @@ ## Overview Nu Replayer is a standalone add-on for Planets Nu, written in FreeBASIC. It is designed to build and view replays of completed games. Nu Replayer is currently in beta, as most core features are in place. -## Interface ## +## Interface The default interface that is opened up is a menu, housing access to the game list, network functions, and configuration. -### Game Room ### +### Game Room The game room is a common interface, originally the default when Nu Replayer is first opened. It contains a list of finished games, and a filter can be applied to make it easier to find a desired game. -### Starmap ### +### Starmap After a suitable game has been selected (either with converted or raw files present), then the game opens into the starmap interface, converting the last turn of the game to a more readable format if necessary. By default, the starmap is accessed using the entire screen. To get a smaller window (if one is using a desktop >1024×768), simply turn on the Compressed View setting in the Engine Options. @@ -16,26 +16,10 @@ The starmap interface contains many useful features. The most notable features o Turns within a game can be navigate with PageUp / PageDown, or a specific turn can be reached via Ctrl+J. -### Object Lists ### +### Object Lists Nu Replayer carries multiple object lists that supplement the starmap. These lists come in their own screen and, as a result, will need to be accessed with a key in order to view the list. The playerlist is currently bound to F5, the planet list to F6, and the ship list to F7. -## Networking ## +## Networking Starting with version 0.60, Nu Replayer now features complete network support, allowing downloading of lists and turns *without* relying on any other tools (not even a web browser). Raw game lists can be downloaded and auto-converted to CSV. Additionally, it is possible to download a complete game just by visiting the download room. The download room functions similarly to the game room, only it serves the exclusive purpose of downloading *new* games. - -## Installing ## -Installing under Windows is very simple. All you have to do (if you haven't already done so) is extract the package that Nu Replayer and its assets were in, and you are all set. Nu Replayer has been tested on Windows XP/7/8/10. It has been compiled using FreeBASIC 1.09.0. - -### GNU/Linux ### -Installing under GNU/Linux, on the other hand, is not so simple. Since the architecture for this system is all over the place, no binaries are provided for GNU/Linux, so you must compile from the included source. Furthermore, FreeBASIC has not been seen in any package manager, so you will likely need to download it directly from the developer website and follow its installation instructions. A simple makefile is supplied. - -You will likely need to install additional libraries, notably development variants of SDL, SDL_mixer, SDL_net, zlib, and libzip. Feel free to poke around until you are able to get a spiffy new binary built just for your system. - -### FreeBSD ### -FreeBSD support was added in FreeBASIC 1.09.0. We presume instructions are similiar to GNU/Linux, but this is untested. Feel free to experiment as need be, until you are able to build your own program. - -### Wine ### -Alternatively, if you can figure out how to use [Wine](http://www.winehq.org/), then you can use it to run the pre-compiled Windows binaries. This is likely the only way to run Nu Replayer outside of the systems above, as FreeBASIC compiler tools are not provided for any other platforms (except DOS). - -That being said, it *might* be remotely possible to compile a native DOS build, but this is extremely tricky to pull off, and is impossible to cross-compile from a 64-bit Windows system. Nu Replayer also does not currently comply with the 8.3 filename system. To summarize, building for DOS is untested.