diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml new file mode 100644 index 00000000..2dbe97c5 --- /dev/null +++ b/.github/workflows/mdbook.yml @@ -0,0 +1,60 @@ +# Sample workflow for building and deploying a mdBook site to GitHub Pages +# +# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html +# +name: Deploy mdBook site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["master"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + env: + MDBOOK_VERSION: 0.4.36 + steps: + - uses: actions/checkout@v4 + - name: Install mdBook + run: | + curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh + rustup update + cargo install --version ${MDBOOK_VERSION} mdbook + - name: Setup Pages + id: pages + uses: actions/configure-pages@v5 + - name: Build with mdBook + run: mdbook build docs/ + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/book + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index 8f9b13a4..c787f596 100644 --- a/.gitignore +++ b/.gitignore @@ -292,23 +292,5 @@ TestMap/ # Decompiled project DerailValley/ -### Package Builder -# What kind of git nonsense is this... -# Required Assets -!PackageBuilder/ -PackageBuilder/* -!PackageBuilder/Assets/ -PackageBuilder/Assets/* -!PackageBuilder/Assets/Mapify/ -!PackageBuilder/Assets/Mapify.meta -PackageBuilder/Assets/Mapify/Scripts/* -!PackageBuilder/Assets/Mapify/Scripts/*meta -# Project Settings -!PackageBuilder/ProjectSettings/ -PackageBuilder/ProjectSettings/* -!PackageBuilder/ProjectSettings/ProjectSettings.asset -!PackageBuilder/ProjectSettings/EditorSettings.asset -!PackageBuilder/ProjectSettings/PackageManagerSettings.asset -!PackageBuilder/ProjectSettings/ProjectVersion.txt -# Packages -!PackageBuilder/Packages +# docs generated files +docs/book diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index ec3918bd..00000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,20 +0,0 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Set the version of Python and other tools you might need -build: - os: ubuntu-22.04 - tools: - python: "3.11" - -mkdocs: - configuration: mkdocs.yml - -# Optionally declare the Python requirements required to build your docs -python: - install: - - requirements: docs/requirements.txt diff --git a/PackageBuilder/.gitignore b/PackageBuilder/.gitignore new file mode 100644 index 00000000..93d55721 --- /dev/null +++ b/PackageBuilder/.gitignore @@ -0,0 +1,82 @@ +# Mapify scripts +Assets/Mapify/Scripts/*.dll + +# Project Settings +ProjectSettings/* +!ProjectSettings/ProjectSettings.asset +!ProjectSettings/EditorSettings.asset +!ProjectSettings/PackageManagerSettings.asset +!ProjectSettings/ProjectVersion.txt + +# This .gitignore file should be placed at the root of your Unity project directory +# +# Get latest from https://github.com/github/gitignore/blob/main/Unity.gitignore +# +/[Ll]ibrary/ +/[Tt]emp/ +/[Oo]bj/ +/[Bb]uild/ +/[Bb]uilds/ +/[Ll]ogs/ +/[Uu]ser[Ss]ettings/ + +# MemoryCaptures can get excessive in size. +# They also could contain extremely sensitive data +/[Mm]emoryCaptures/ + +# Recordings can get excessive in size +/[Rr]ecordings/ + +# Uncomment this line if you wish to ignore the asset store tools plugin +# /[Aa]ssets/AssetStoreTools* + +# Autogenerated Jetbrains Rider plugin +/[Aa]ssets/Plugins/Editor/JetBrains* + +# Visual Studio cache directory +.vs/ + +# Gradle cache directory +.gradle/ + +# Autogenerated VS/MD/Consulo solution and project files +ExportedObj/ +.consulo/ +*.csproj +*.unityproj +*.sln +*.suo +*.tmp +*.user +*.userprefs +*.pidb +*.booproj +*.svd +*.pdb +*.mdb +*.opendb +*.VC.db + +# Unity3D generated meta files +*.pidb.meta +*.pdb.meta +*.mdb.meta + +# Unity3D generated file on crash reports +sysinfo.txt + +# Builds +*.apk +*.aab +*.unitypackage +*.app + +# Crashlytics generated file +crashlytics-build.properties + +# Packed Addressables +/[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*/*.bin* + +# Temporary auto-generated Android Assets +/[Aa]ssets/[Ss]treamingAssets/aa.meta +/[Aa]ssets/[Ss]treamingAssets/aa/* diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 00000000..b621c339 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +title = "Mapify" +authors = ["Insprill", "Tostiman"] + +[output.html] +git-repository-url = "https://github.com/Insprill/dv-mapify" diff --git a/docs/contributing/docs.md b/docs/contributing/docs.md deleted file mode 100644 index c1e757a4..00000000 --- a/docs/contributing/docs.md +++ /dev/null @@ -1,21 +0,0 @@ -# Building Documentation - ---- - -To build Mapify's docs, you'll need to have Python 3 and Pip installed. - -- [How to install Python](https://wiki.python.org/moin/BeginnersGuide/Download) -- [How to install pip](https://pip.pypa.io/en/stable/installation/) - -To install the required dependencies, you can run the following command: -```shell -python -m pip install -r docs/requirements.txt -``` -To serve the documentation locally, you can run -```shell -python -m mkdocs serve -``` - -It can then be accessed at [http://127.0.0.1:8000/](http://127.0.0.1:8000/). - -For information on how MkDocs works, check out [their documentation](https://www.mkdocs.org/getting-started/#adding-pages). diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 407b8df6..00000000 --- a/docs/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# Welcome - -![Banner][banner-image] - -Mapify is a [Derail Valley][derail-valley-website] mod for creating and loading custom maps. -Here you can find all the information you'll need to create maps and contribute to the project! - -If you want to start creating maps, head to the [Project Setup][project-setup] page. -If you want to contribute to the project through code or documentation improvements, check out the [Contributing][contributing] page. - -If you're just a user who wants to install and use maps, visit the [Using Maps][using-maps] page. - -[derail-valley-website]: https://www.derailvalley.com/ -[project-setup]: creatingmaps/project-setup.md -[contributing]: contributing/index.md -[using-maps]: usage/index.md -[banner-image]: assets/banner.png diff --git a/docs/requirements.in b/docs/requirements.in deleted file mode 100644 index 9a8a4ca4..00000000 --- a/docs/requirements.in +++ /dev/null @@ -1,2 +0,0 @@ -mkdocs -mkdocs-material diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 17a73b51..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,64 +0,0 @@ -# -# This file is autogenerated by pip-compile with Python 3.10 -# by the following command: -# -# pip-compile docs/requirements.in -# -certifi==2024.7.4 - # via requests -charset-normalizer==3.1.0 - # via requests -click==8.1.3 - # via mkdocs -colorama==0.4.6 - # via mkdocs-material -ghp-import==2.1.0 - # via mkdocs -idna==3.7 - # via requests -jinja2==3.1.6 - # via - # mkdocs - # mkdocs-material -markdown==3.3.7 - # via - # mkdocs - # mkdocs-material - # pymdown-extensions -markupsafe==2.1.2 - # via jinja2 -mergedeep==1.3.4 - # via mkdocs -mkdocs==1.4.2 - # via - # -r requirements.in - # mkdocs-material -mkdocs-material==9.1.6 - # via -r requirements.in -mkdocs-material-extensions==1.1.1 - # via mkdocs-material -packaging==23.0 - # via mkdocs -pygments==2.15.0 - # via mkdocs-material -pymdown-extensions==10.0 - # via mkdocs-material -python-dateutil==2.8.2 - # via ghp-import -pyyaml==6.0 - # via - # mkdocs - # pymdown-extensions - # pyyaml-env-tag -pyyaml-env-tag==0.1 - # via mkdocs -regex==2023.3.23 - # via mkdocs-material -requests==2.32.4 - # via mkdocs-material -six==1.16.0 - # via python-dateutil -urllib3==2.5.0 - # via requests -watchdog==3.0.0 - # via mkdocs diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 00000000..14415186 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,28 @@ +# Summary + +[Home](./index.md) + +# User guide + +- [Using maps](./usage/index.md) + +# Development + +- [Creating maps](./creatingmaps/index.md) + - [Project Setup](./creatingmaps/project-setup.md) + - [Terrain](./creatingmaps/terrain.md) + - [Decoration](./creatingmaps/decoration.md) + - [Railway](./creatingmaps/railway.md) + - [Job Generation](./creatingmaps/jobs.md) + - [Area Blockers](./creatingmaps/area-blockers.md) + - [Service Stations](./creatingmaps/service-stations.md) + - [Stores](./creatingmaps/stores.md) + - [Lighting & Post Processing](./creatingmaps/lighting.md) + - [Exporting Your Map](./creatingmaps/exporting.md) + - [Updating Mapify](./creatingmaps/updating.md) + +- [Contributing to Mapify](./contributing/index.md) + - [Building The Project](./contributing/building.md) + - [Building Documentation](./contributing/docs.md) + + diff --git a/docs/assets/banner.png b/docs/src/assets/banner.png similarity index 100% rename from docs/assets/banner.png rename to docs/src/assets/banner.png diff --git a/docs/assets/build-settings.png b/docs/src/assets/build-settings.png similarity index 100% rename from docs/assets/build-settings.png rename to docs/src/assets/build-settings.png diff --git a/docs/assets/color-space-setting.png b/docs/src/assets/color-space-setting.png similarity index 100% rename from docs/assets/color-space-setting.png rename to docs/src/assets/color-space-setting.png diff --git a/docs/assets/gizmos.png b/docs/src/assets/gizmos.png similarity index 100% rename from docs/assets/gizmos.png rename to docs/src/assets/gizmos.png diff --git a/docs/assets/scenes.png b/docs/src/assets/scenes.png similarity index 100% rename from docs/assets/scenes.png rename to docs/src/assets/scenes.png diff --git a/docs/assets/terrain-toolbox.png b/docs/src/assets/terrain-toolbox.png similarity index 100% rename from docs/assets/terrain-toolbox.png rename to docs/src/assets/terrain-toolbox.png diff --git a/docs/assets/track-pieces.png b/docs/src/assets/track-pieces.png similarity index 100% rename from docs/assets/track-pieces.png rename to docs/src/assets/track-pieces.png diff --git a/docs/assets/unity-hub-new-project.png b/docs/src/assets/unity-hub-new-project.png similarity index 100% rename from docs/assets/unity-hub-new-project.png rename to docs/src/assets/unity-hub-new-project.png diff --git a/docs/assets/xr-settings.png b/docs/src/assets/xr-settings.png similarity index 100% rename from docs/assets/xr-settings.png rename to docs/src/assets/xr-settings.png diff --git a/docs/contributing/building.md b/docs/src/contributing/building.md similarity index 100% rename from docs/contributing/building.md rename to docs/src/contributing/building.md diff --git a/docs/src/contributing/docs.md b/docs/src/contributing/docs.md new file mode 100644 index 00000000..7ee87369 --- /dev/null +++ b/docs/src/contributing/docs.md @@ -0,0 +1,11 @@ +# Building Documentation + +--- + +To build Mapify's docs, first install mdBook by following the [installation instructions here](https://rust-lang.github.io/mdBook/guide/installation.html). + +Run `mdbook serve --open` in the `docs` folder to view the documentation in your webbrowser. + +To build the docs, run `mdbook build`. + +For information on how mdBook works, check out [their documentation](https://rust-lang.github.io/mdBook/index.html). diff --git a/docs/contributing/index.md b/docs/src/contributing/index.md similarity index 100% rename from docs/contributing/index.md rename to docs/src/contributing/index.md diff --git a/docs/creatingmaps/area-blockers.md b/docs/src/creatingmaps/area-blockers.md similarity index 100% rename from docs/creatingmaps/area-blockers.md rename to docs/src/creatingmaps/area-blockers.md diff --git a/docs/creatingmaps/decoration.md b/docs/src/creatingmaps/decoration.md similarity index 100% rename from docs/creatingmaps/decoration.md rename to docs/src/creatingmaps/decoration.md diff --git a/docs/creatingmaps/exporting.md b/docs/src/creatingmaps/exporting.md similarity index 100% rename from docs/creatingmaps/exporting.md rename to docs/src/creatingmaps/exporting.md diff --git a/docs/src/creatingmaps/index.md b/docs/src/creatingmaps/index.md new file mode 100644 index 00000000..5402648b --- /dev/null +++ b/docs/src/creatingmaps/index.md @@ -0,0 +1,3 @@ +# Creating maps + +So you want to create your own map? Great! Start here: [Project Setup](./creatingmaps/project-setup.md). diff --git a/docs/creatingmaps/jobs.md b/docs/src/creatingmaps/jobs.md similarity index 100% rename from docs/creatingmaps/jobs.md rename to docs/src/creatingmaps/jobs.md diff --git a/docs/creatingmaps/lighting.md b/docs/src/creatingmaps/lighting.md similarity index 100% rename from docs/creatingmaps/lighting.md rename to docs/src/creatingmaps/lighting.md diff --git a/docs/creatingmaps/project-setup.md b/docs/src/creatingmaps/project-setup.md similarity index 100% rename from docs/creatingmaps/project-setup.md rename to docs/src/creatingmaps/project-setup.md diff --git a/docs/creatingmaps/railway.md b/docs/src/creatingmaps/railway.md similarity index 100% rename from docs/creatingmaps/railway.md rename to docs/src/creatingmaps/railway.md diff --git a/docs/creatingmaps/service-stations.md b/docs/src/creatingmaps/service-stations.md similarity index 100% rename from docs/creatingmaps/service-stations.md rename to docs/src/creatingmaps/service-stations.md diff --git a/docs/creatingmaps/stores.md b/docs/src/creatingmaps/stores.md similarity index 100% rename from docs/creatingmaps/stores.md rename to docs/src/creatingmaps/stores.md diff --git a/docs/creatingmaps/terrain.md b/docs/src/creatingmaps/terrain.md similarity index 100% rename from docs/creatingmaps/terrain.md rename to docs/src/creatingmaps/terrain.md diff --git a/docs/creatingmaps/updating.md b/docs/src/creatingmaps/updating.md similarity index 100% rename from docs/creatingmaps/updating.md rename to docs/src/creatingmaps/updating.md diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 00000000..d32a39d4 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,11 @@ +# Welcome + +![Banner](assets/banner.png) + +Mapify is a [Derail Valley](https://www.derailvalley.com/) mod for creating and loading custom maps. +Here you can find all the information you'll need to create maps and contribute to the project! + +If you want to start creating maps, head to the [Project Setup](./creatingmaps/project-setup.md) page. +If you want to contribute to the project through code or documentation improvements, check out the [Contributing](./contributing/index.md) page. + +If you're just a user who wants to install and use maps, visit the [Using maps](./usage/index.md) page. diff --git a/docs/usage/index.md b/docs/src/usage/index.md similarity index 100% rename from docs/usage/index.md rename to docs/src/usage/index.md diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 42b211f5..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,57 +0,0 @@ -site_name: Mapify -site_description: Documentation for Mapify - -site_url: https://dv-mapify.rtfd.io/ -repo_name: insprill/dv-mapify -repo_url: https://github.com/Insprill/dv-mapify/ -edit_uri: blob/master/docs/ - -theme: - name: material - palette: - scheme: slate - features: - - content.action.edit - - content.code.annotate - - content.code.copy - - content.tooltips - - navigation.footer - - navigation.indexes - - navigation.instant - - navigation.prune - - navigation.sections - - navigation.top - - navigation.tracking - - search.highlight - - search.share - - search.suggest - - toc.follow - -markdown_extensions: - - pymdownx.caret - - pymdownx.highlight: - anchor_linenums: true - - pymdownx.inlinehilite - - pymdownx.snippets - - pymdownx.superfences - -nav: - - Home: index.md - - Using Maps: - - usage/index.md - - Creating Maps: - - Project Setup: creatingmaps/project-setup.md - - Terrain: creatingmaps/terrain.md - - Decoration: creatingmaps/decoration.md - - Railway: creatingmaps/railway.md - - Job Generation: creatingmaps/jobs.md - - Area Blockers: creatingmaps/area-blockers.md - - Service Stations: creatingmaps/service-stations.md - - Stores: creatingmaps/stores.md - - Lighting & Post Processing: creatingmaps/lighting.md - - Exporting Your Map: creatingmaps/exporting.md - - Updating Mapify: creatingmaps/updating.md - - Contributing: - - contributing/index.md - - Building The Project: contributing/building.md - - Building Documentation: contributing/docs.md