Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 6.19 KB

README.md

File metadata and controls

76 lines (56 loc) · 6.19 KB

Mappalachia

The complete mapping tool for Fallout 76.
Mappalachia is a Windows application for generating and exporting complex maps of entities within the Fallout 76 game world.

Latest release

Latest release

Discord
License

Download and Installation

Download Mappalachia.zip here to get started generating maps. Simply unzip it to a folder and then launch Mappalachia.exe.
For help installing please refer to the installation and first launch guide.

Getting started - User Guides

A number of User guides exist for Mappalachia in document form;

  • Installation and First run covers initial installation and getting Mappalachia running.
  • First map explains the basic steps to creating your first Mappalachia map and other core features.
  • Customization Options covers all the various customization and visual options for your map.
  • Advanced Searching explains the intelligent NPC, Scrap and Region search functions, as well as using filters to find exactly what you need.
  • Advanced Plotting details the powerful cluster mode, as well as topographical and heatmap plotting, item grouping and volume mapping.
  • Interiors and other Spaces explains the mapping of other spaces such as interiors.
  • In-Game Map mod explains how to use third-party tools to create a mod which replaces the in-game map with your own Mappalachia map.

Discord

Join the Mappalachia Discord for discussion and help.

Info for Developers

Alongside the source code for the GUI itself, this repository also contains the necessary scripts and code used to export, preprocess and build the Mappalachia database and supporting image assets.

The required information is compiled in 5 key steps.

  1. Extract the raw data in CSV using FO76Edit
  2. Refine and preprocess the data
  3. Ingest the data into a database
  4. (Optional) Image Asset extraction and rendering
  5. Image Asset and data validation

If you fancy doing some data mining or development with Mappalachia then you may be interested in the following documentation;

  • FO76Edit scripts explains using FO76Edit to run the Mappalachia edit scripts to export rough, raw game data.
  • Preprocessor covers using the CLI tool to process and refine the rough data into suitable CSVs.
  • Database Ingest covers using SQLite to ingest the CSVs into a database which Mappalachia can read.
  • Map Icon extraction explains the process of exporting map marker icons from the game to Mappalachia.
  • Background Image Rendering explains using the powerful fo76utils to render top-down views of locations, used for map backgrounds.
  • Image Asset Validation walks through how all image assets can be validated ready for a release.
  • GUI covers developing the Mappalachia GUI itself, including how to update Mappalachia following a new game update.

Thanks

  • Every single person who has so generously donated to say thanks for Mappalachia.
  • Contributors to and developers of XEdit and FO76Edit, namely Eckserah.
  • Members of the FO76 Datamining Discord, for helping out with FO76Edit and Edit Scripts, and offering valuable knowledge and feedback based on their own experiences datamining and creating Fallout 76 maps.
  • fo76utils for their excellent and powerful render tool, used to render backgrounds for all cell maps and the Appalachia satellite map option.
  • Gilpo for providing great ideas and feedback for new Mappalachia features.
  • Duchess Flame for useful feature feedback, driving community engagement and moral support.
  • frame for reporting and helping to test DPI scaling issues.
  • Everyone who ever gave feedback to the original Mappalachia. Your feedback, comments, questions, and PMs were essential to defining and guiding the features I have been able to bring to life here.

Licensing

This project is licensed under the GNU General Public License 3.0 - see LICENSE.md for details.
Mappalachia uses technologies such as SQLite and SVG.NET which are each subject to their own licenses.
Use of other third-party assets are covered below.

Legal/Disclaimer

Mappalachia is provided as a non-commercial, free tool solely for the benefit of players of Fallout 76. Mappalachia and its creator are neither affiliated with - nor endorsed by - ZeniMax Media or any of its subsidiaries including Bethesda Softworks LLC. Game assets including but not limited to images, characters, names and other game data used for mapping are extracted from a purchased copy of Fallout 76 and are shared here with the game's community in good faith and with an understanding that this lies within fair use.
Any game data shared here is done so with the explicit purpose of making maps for the benefit of the community, and great care has been taken to minimize such data so that it cannot be reconstructed in any meaningful way.
If you have any concerns or queries, please direct them to mappalachia.feedback@gmail.com