LegendsViewer-Next

Before installing, ensure you have the following installed on your system:

• .NET 10 SDK
• Node.js

The legends-viewer-frontend package is a development template built using Vue 3, TypeScript, and Vite. It utilizes Vue 3 <script setup> Single File Components (SFCs) for a streamlined development experience.

To build on top of this project, ensure your development environment is configured for TypeScript and follows the recommended Vue project setup patterns.

LegendsViewer-Next visualizes Dwarf Fortress world data. To use it, you must provide exported XML files from the game.

Loading World Data

1. Export a world from Dwarf Fortress.
2. Upload the XML file into the application.

Required Files

• Minimum Requirement: The export must contain a file named <savename>-<datestamp>-legends.xml.
• Enhanced Features: To enable map generation and advanced information, you must provide the <savename>-<datestamp>-legends_plus.xml file, which is generated when performing an export using DFHack.

If you need to run the frontend development server independently from the backend, follow these steps within the legends-viewer-frontend directory:

1. Navigate to the frontend directory.
2. Install dependencies using npm install.
3. Start the development server using npm run dev.
4. Open the provided local URL in your browser.

cd LegendsViewer.Frontend/legends-viewer-frontend
npm install
npm run dev

To set up a development environment for LegendsViewer-Next, you must configure both the .NET 10 backend and the Vue 3/TypeScript frontend. Running the backend project via dotnet run is designed to build and host the frontend automatically.

# 1. Clone the repository
git clone https://github.com/Kromtec/LegendsViewer-Next.git
cd LegendsViewer-Next

# 2. Restore and run the backend
# This also builds and hosts the frontend
dotnet restore
dotnet run --project LegendsViewer.Backend/LegendsViewer.Backend.csproj