diff --git a/README.md b/README.md index beec0006..93a67505 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,102 @@ # Fallout 2 Community Engine -Fallout 2 Community Engine is a fully working re-implementation of the Fallout 2 engine, optimized for a hassle-free experience on multiple platforms. It provides high resolution support, quality-of-life improvements, and dozens of bug fixes. +Fallout 2 Community Engine is a fully working re-implementation of the Fallout 2 engine, optimized for a hassle-free experience on multiple platforms, including Windows, Mac, iOS, Android, and Linux. It provides high resolution support, quality-of-life improvements, and dozens upon dozens of bug fixes. This is a fork of the original Fallout2: CE project, which is no longer getting regular updates. -Popular Fallout 2 total conversion mods are partially supported. Original versions of Nevada and Sonora (that do not rely on extended features provided by Sfall) work. [Fallout 2 Restoration Project](https://github.com/BGforgeNet/Fallout2_Restoration_Project) is supported (in Beta). [Fallout Et Tu](https://github.com/rotators/Fo1in2) and [Olympus 2207](https://olympus2207.com) are not yet supported. Other mods (particularly Resurrection and Yesterday) are not tested. +Popular Fallout 2 total conversion mods are partially supported. Nevada and Sonora work. [Fallout 2 Restoration Project](https://github.com/BGforgeNet/Fallout2_Restoration_Project) is supported (in Beta). [Fallout Et Tu](https://github.com/rotators/Fo1in2) and [Olympus 2207](https://olympus2207.com) are not yet supported. Other mods (particularly Resurrection and Yesterday) are not tested. -Fallout2: CE has broad (though not total) compatibility with [Sfall](https://github.com/sfall-team/sfall) scripting extensions. Many traditional Fallout mods work out of the box. +Fallout2: CE has broad (though not total) compatibility with [Sfall](https://github.com/sfall-team/sfall) scripting extensions. Many traditional Fallout mods work out of the box, including NPC Armor, Party Orders, FO2Tweaks (we recommend v14.5+), Talking Heads, and many others. -There is also [Fallout 1 Community Edition](https://github.com/alexbatalov/fallout1-ce) (not affiliated with this fork). +## Installation — [Download Latest CE Release](https://github.com/fallout2-ce/fallout2-ce/releases) -## Installation +You *must* own the game to play. Purchase your copy on [GOG](https://www.gog.com/game/fallout_2), [Epic Games](https://store.epicgames.com/p/fallout-2) or [Steam](https://store.steampowered.com/app/38410). -You *must* own the game to play. Purchase your copy on [GOG](https://www.gog.com/game/fallout_2), [Epic Games](https://store.epicgames.com/p/fallout-2) or [Steam](https://store.steampowered.com/app/38410). Download latest [release](https://github.com/fallout2-ce/fallout2-ce/releases) or build from source. +Download CE from the link above, then extract the archive into your game folder. Launch `fallout2-ce.exe` on Windows (or the platform-specific executable) to play. CE has a lot of enhancements that require configuration. See [Configuration](#configuration) for examples. + +For detailed instructions on how to play on Mac, Linux, iOS, or Android, see the [Platform-specific instructions](#platform-specific-installation). + +## Quality of life benefits over vanilla Fallout + +* High resolution support +* Party members can loot and barter in place of PC +* Directly equip party members instead of convincing them to use the right equipment. +* Expanded 2-column inventory, loot screens +* Expanded 4-row barter screen +* Expanded AP bar +* Ctrl-click to quickly move items when bartering, looting, or stealing, and auto-balance caps +* Music continues playing between maps +* Auto open doors +* Integrated "HELP" menu +* 44.1 kHz stereo sound/music supported, in .ogg and .wav format as well as legacy .acm +* Last used save slot is remembered +* Item/Corpse/Container/Critter highlighting (configure using [mods/sfall-mods.ini](https://github.com/sfall-team/sfall/blob/master/artifacts/config_files/sfall-mods.ini)) + + + + + + + + + + + +
+ Expanded 2-column inventory
+ Expanded 2-column inventory + 		+ Companion equip screen
+ Companion equip screen +
+ Party member loot
+ Party member loot + 		+ Integrated HELP menu
+ Integrated HELP menu +
+ +There are also dozens of small things that just work a little better than they did in the original. Better pathfinding, fewer graphics glitches, less finicky weapon stacking, and much more. + +## Configuration + +The main configuration file is `fallout2.cfg`. This contains original game config as well as new CE settings. + +Additional settings for screen resolution, UI customization, and map options are now integrated into the main `fallout2.cfg` file (previously part of `f2_res.ini` from Mash's HRP). + +Here are some important settings in `fallout2.cfg` under the `[screen]` and `[ui]` sections. See [the example config](https://github.com/fallout2-ce/fallout2-ce/tree/refs/heads/main/files/fallout2.cfg) for a full list of settings. + +```ini +[screen] +resolution_x=1600 ; actual game window size (screen resolution), in pixels +resolution_y=1080 +windowed=1 ; 0 = fullscreen +scale=2 ; 1 = original scale, 2 = 2x scale, etc. (e.g. at scale 2 and screen resolution 1920x1080, in-game resolution will be 960x540, thus every pixel is twice as wide and tall) + +[ui] +; Maximum number of columns shown in the main inventory and loot/steal windows (valid range: 1..2) +inventory_columns=2 + +; Set to 1 to expand the barter/trade window vertically, adding a 4th item slot per side (requires ce.dat) +expand_barter_window=1 + +[qol] +; Allow opening party member inventory from the long-press context menu. +party_trade_from_menu=1 + +; Allow switching to companions' inventories in loot screens (and barter, in the future) +party_loot_and_barter=1 +``` + +**Recommendations:** +- **Desktops**: Use any size you see fit. +- **Tablets**: Set these values to logical resolution of your device, for example iPad Pro 11 is 1668x2388 (pixels), but its logical resolution is 834x1194 (points). +- **Mobile phones**: Set height to 480, calculate width according to your device screen (aspect) ratio, for example Samsung S21 is 20:9 device, so the width should be 480 * 20 / 9 = 1067. + +In time this stuff will receive an in-game interface, right now you have to do it manually. To see all currently working fallout2.cfg settings, just run the game once and quit. It will be automatically updated with defaults for every supported setting. +*Note*: Use of the IFACE_BAR settings requires the `f2_res.dat` file, which contains graphical assets. Various versions are available, but one compatible with the above settings can be found here: [f2_res.dat](https://github.com/fallout2-ce/fallout2-ce/raw/refs/heads/main/files/f2_res.dat) + +## Platform-specific installation ### Windows @@ -103,57 +187,6 @@ docker run --rm -v $(pwd):/src emscripten/emsdk:3.1.74 sh -c 'git config --globa ``` - Demo available at https://github.com/ololoken/fallout2-ce-ems.git -## Configuration - -The main configuration file is `fallout2.cfg`. There are several important settings you might need to adjust for your installation. Depending on your Fallout distribution main game assets `master.dat`, `critter.dat`, `patch000.dat`, and `data` folder might be either all lowercased, or all uppercased. You can either update `master_dat`, `critter_dat`, `master_patches` and `critter_patches` settings to match your file names, or rename files to match entries in your `fallout2.cfg`. - -The `sound` folder (with `music` folder inside) might be located either in `data` folder, or be in the Fallout folder. Update `music_path1` setting to match your hierarchy, usually it's `data/sound/music/` or `sound/music/`. Make sure it matches your path exactly (so it might be `SOUND/MUSIC/` if you've installed Fallout from CD). Music files themselves (with `ACM` extension) should be all uppercased, regardless of `sound` and `music` folders. - -Additional settings for screen resolution, UI customization, and map options are now integrated into the main `fallout2.cfg` file (previously part of `f2_res.ini` from Mash's HRP). When Fallout 2 CE starts, if it detects an existing `f2_res.ini` file, it automatically migrates these settings into `fallout2.cfg`. After migration, `fallout2.cfg` becomes the single source of truth for this configuration. - -Here are some important settings in `fallout2.cfg` under the `[screen]` and `[ui]` sections. See [the example config](https://github.com/fallout2-ce/fallout2-ce/tree/refs/heads/main/files/fallout2.cfg) for a full list of settings. - -```ini -[screen] -resolution_x=1600 ; actual game window size (screen resolution), in pixels -resolution_y=1080 -windowed=1 ; 0 = fullscreen -scale=2 ; 1 = original scale, 2 = 2x scale, etc. (e.g. at scale 2 and screen resolution 1920x1080, in-game resolution will be 960x540, thus every pixel is twice as wide and tall) - -[ui] -;Set to 1 to expand the barter/trade window vertically, adding a 4th item slot per side (requires ce.dat) -expand_barter_window=1 -;Maximum number of columns shown in the main inventory and loot/steal windows (valid range: 1..2) -inventory_columns=2 -splash_screen_size=1 ; Splash screen scaling (0=original size, 1=fit preserving aspect, 2=stretch to fill) -quick_toolbar_visible=0 ; Skills quick access toolbar visibility (iOS only) (0=hidden, 1=visible) -``` - -**Recommendations:** -- **Desktops**: Use any size you see fit. -- **Tablets**: Set these values to logical resolution of your device, for example iPad Pro 11 is 1668x2388 (pixels), but it's logical resolution is 834x1194 (points). -- **Mobile phones**: Set height to 480, calculate width according to your device screen (aspect) ratio, for example Samsung S21 is 20:9 device, so the width should be 480 * 20 / 9 = 1067. - -In time this stuff will receive in-game interface, right now you have to do it manually. To see all currently working fallout2.cfg settings, just run the game once and quit. It will be automatically updated with defaults for every supported setting. -*Note*: Use of the IFACE_BAR settings requires the `f2_res.dat` file, which contains graphical assets. Various versions are available, but one compatible with the above settings can be found here: [f2_res.dat](https://github.com/fallout2-ce/fallout2-ce/raw/refs/heads/main/files/f2_res.dat) - -## Quality of life benefits over vanilla Fallout - -* High resolution support -* Expanded 2-column inventory -* Expanded 4-row barter screen -* Expanded AP bar -* Party members can loot and barter in place of PC -* Increased pathfinding nodes 5x for more accurate pathfinding, and use accurate path length for walk vs run -* Ctrl-click to quickly move items when bartering, looting, or stealing -* _a_ to select "all" when selecting item quantity, and for `Take All` when looting -* When bartering, caps default to the right amount to balance the trade -* Music continues playing between maps -* Auto open doors -* Integrated "HELP" menu -* 44.1 kHz stereo sound/music supported, in .ogg and .wav format as well as legacy .acm -* Last used save slot is remembered -* Item/Corpse/Container/Critter highlighting (configure using [mods/sfall-mods.ini](https://github.com/sfall-team/sfall/blob/master/artifacts/config_files/sfall-mods.ini)) ## Contributing diff --git a/docs/images/companion-equip.gif b/docs/images/companion-equip.gif new file mode 100644 index 00000000..cbae9612 Binary files /dev/null and b/docs/images/companion-equip.gif differ diff --git a/docs/images/help-menu.gif b/docs/images/help-menu.gif new file mode 100644 index 00000000..8e0642a7 Binary files /dev/null and b/docs/images/help-menu.gif differ diff --git a/docs/images/party-member-loot.gif b/docs/images/party-member-loot.gif new file mode 100644 index 00000000..c2ca8557 Binary files /dev/null and b/docs/images/party-member-loot.gif differ diff --git a/docs/images/two-column-inventory.jpg b/docs/images/two-column-inventory.jpg new file mode 100644 index 00000000..af176a64 Binary files /dev/null and b/docs/images/two-column-inventory.jpg differ diff --git a/src/settings.h b/src/settings.h index 14f7f27a..86b3b8bc 100644 --- a/src/settings.h +++ b/src/settings.h @@ -65,7 +65,8 @@ struct UISettings { // Expands barter/trade window vertically, adding a 4th item slot per side. bool expand_barter_window = false; - int splash_screen_size = 0; + // Scales the splash screen to fit the screen + int splash_screen_size = 1; // Whether to scale movies to fit the screen while preserving aspect ratio. bool movie_aspect_fit = true;