diff --git a/docs/package.json b/docs/package.json index 22126ed4..9b029b84 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,5 +1,6 @@ { - "name": "bustling-belt", + "name": "nh-docs", + "private": true, "type": "module", "version": "0.0.1", "scripts": { diff --git a/docs/public/details/asset_bundle.webp b/docs/public/details/asset_bundle.webp deleted file mode 100644 index 9484111f..00000000 Binary files a/docs/public/details/asset_bundle.webp and /dev/null differ diff --git a/docs/public/asset_bundle.webp b/docs/src/assets/docs-images/details/asset_bundle.webp similarity index 100% rename from docs/public/asset_bundle.webp rename to docs/src/assets/docs-images/details/asset_bundle.webp diff --git a/docs/public/getting_started/mod_manager_show_in_explorer.webp b/docs/src/assets/docs-images/getting_started/mod_manager_show_in_explorer.webp similarity index 100% rename from docs/public/getting_started/mod_manager_show_in_explorer.webp rename to docs/src/assets/docs-images/getting_started/mod_manager_show_in_explorer.webp diff --git a/docs/public/planet_gen/earth_heightmap.webp b/docs/src/assets/docs-images/planet_gen/earth_heightmap.webp similarity index 100% rename from docs/public/planet_gen/earth_heightmap.webp rename to docs/src/assets/docs-images/planet_gen/earth_heightmap.webp diff --git a/docs/public/ship_log/auto_map_mode.webp b/docs/src/assets/docs-images/ship_log/auto_map_mode.webp similarity index 100% rename from docs/public/ship_log/auto_map_mode.webp rename to docs/src/assets/docs-images/ship_log/auto_map_mode.webp diff --git a/docs/public/ship_log/auto_rumor_mode.webp b/docs/src/assets/docs-images/ship_log/auto_rumor_mode.webp similarity index 100% rename from docs/public/ship_log/auto_rumor_mode.webp rename to docs/src/assets/docs-images/ship_log/auto_rumor_mode.webp diff --git a/docs/public/ship_log/change_color.webp b/docs/src/assets/docs-images/ship_log/change_color.webp similarity index 100% rename from docs/public/ship_log/change_color.webp rename to docs/src/assets/docs-images/ship_log/change_color.webp diff --git a/docs/public/ship_log/child_entry_example.webp b/docs/src/assets/docs-images/ship_log/child_entry_example.webp similarity index 100% rename from docs/public/ship_log/child_entry_example.webp rename to docs/src/assets/docs-images/ship_log/child_entry_example.webp diff --git a/docs/public/ship_log/curiosity_example.webp b/docs/src/assets/docs-images/ship_log/curiosity_example.webp similarity index 100% rename from docs/public/ship_log/curiosity_example.webp rename to docs/src/assets/docs-images/ship_log/curiosity_example.webp diff --git a/docs/public/ship_log/entry_example.webp b/docs/src/assets/docs-images/ship_log/entry_example.webp similarity index 100% rename from docs/public/ship_log/entry_example.webp rename to docs/src/assets/docs-images/ship_log/entry_example.webp diff --git a/docs/public/ship_log/entry_position.webp b/docs/src/assets/docs-images/ship_log/entry_position.webp similarity index 100% rename from docs/public/ship_log/entry_position.webp rename to docs/src/assets/docs-images/ship_log/entry_position.webp diff --git a/docs/public/ship_log/explore_example.webp b/docs/src/assets/docs-images/ship_log/explore_example.webp similarity index 100% rename from docs/public/ship_log/explore_example.webp rename to docs/src/assets/docs-images/ship_log/explore_example.webp diff --git a/docs/public/ship_log/map_indices.webp b/docs/src/assets/docs-images/ship_log/map_indices.webp similarity index 100% rename from docs/public/ship_log/map_indices.webp rename to docs/src/assets/docs-images/ship_log/map_indices.webp diff --git a/docs/public/ship_log/rumor_example.webp b/docs/src/assets/docs-images/ship_log/rumor_example.webp similarity index 100% rename from docs/public/ship_log/rumor_example.webp rename to docs/src/assets/docs-images/ship_log/rumor_example.webp diff --git a/docs/public/star_systems/hearthian_solar_system_coordinates.webp b/docs/src/assets/docs-images/star_systems/hearthian_solar_system_coordinates.webp similarity index 100% rename from docs/public/star_systems/hearthian_solar_system_coordinates.webp rename to docs/src/assets/docs-images/star_systems/hearthian_solar_system_coordinates.webp diff --git a/docs/public/star_systems/nomai_coordinate_indexes.webp b/docs/src/assets/docs-images/star_systems/nomai_coordinate_indexes.webp similarity index 100% rename from docs/public/star_systems/nomai_coordinate_indexes.webp rename to docs/src/assets/docs-images/star_systems/nomai_coordinate_indexes.webp diff --git a/docs/src/content/docs/guides/details.md b/docs/src/content/docs/guides/details.md index 4a100211..dc45e070 100644 --- a/docs/src/content/docs/guides/details.md +++ b/docs/src/content/docs/guides/details.md @@ -72,7 +72,7 @@ public class CreateAssetBundles 3. Create your object in the Unity scene and save it as a prefab. 4. Add all files used (models, prefabs, textures, materials, etc.) to an asset bundle by selecting them and using the dropdown in the bottom right. Here I am adding a rover model to my "rss" asset bundle for the Real Solar System add-on. -![setting asset bundle](/details/asset_bundle.webp) +![setting asset bundle](@/assets/docs-images/details/asset_bundle.webp) 1. In the top left click the "Assets" drop-down and select "Build AssetBundles". This should create your asset bundle in a folder in the root directory called "StreamingAssets". 2. Copy the asset bundle and asset bundle .manifest files from StreamingAssets into your mod's "planets" folder. If you did everything properly they should work in game. To double-check everything is included, open the .manifest file in a text editor to see the files included and their paths. diff --git a/docs/src/content/docs/guides/planet-generation.md b/docs/src/content/docs/guides/planet-generation.md index cdc8f6de..687db4e9 100644 --- a/docs/src/content/docs/guides/planet-generation.md +++ b/docs/src/content/docs/guides/planet-generation.md @@ -15,7 +15,7 @@ Heightmaps are a way to generate unique terrain on your planet. First you specif Here's an example heightmap of earth from the Real Solar System addon. -![Earth's Heightmap](/planet_gen/earth_heightmap.webp) +![Earth's Heightmap](@/assets/docs-images/planet_gen/earth_heightmap.webp) ```json { diff --git a/docs/src/content/docs/guides/ship-log.md b/docs/src/content/docs/guides/ship-log.md index b65cec1b..7260cc1e 100644 --- a/docs/src/content/docs/guides/ship-log.md +++ b/docs/src/content/docs/guides/ship-log.md @@ -13,7 +13,7 @@ An entry is a card you see in rumor mode, it represents a specific area or conce village or the southern observatory on Brittle Hollow. An entry is split up into facts, a fact can either be a rumor fact or an explore fact. -![entryExample](/ship_log/entry_example.webp) +![entryExample](@/assets/docs-images/ship_log/entry_example.webp) _In red you can see an entry, in green you can see the entry's facts_ #### Curiosities @@ -22,14 +22,14 @@ Curiosities are entries that represent big ideas in the story, such as the ATP o Non-curiosity entries have a Curiosity attribute that can be set to make the color of that entry match the color of the curiosity (Like how everything regarding the Vessel is red) -![curiosityExample](/ship_log/curiosity_example.webp) +![curiosityExample](@/assets/docs-images/ship_log/curiosity_example.webp) _The Ash Twin Project is an example of a curiosity (internally it's called TIME_LOOP)_ #### Child Entries Entries can be children of other entries, meaning they'll be smaller. -![childEntryExample](/ship_log/child_entry_example.webp) +![childEntryExample](@/assets/docs-images/ship_log/child_entry_example.webp) _The murals at the old settlement on Brittle Hollow are examples of child entries_ ### Rumor Facts @@ -37,13 +37,13 @@ _The murals at the old settlement on Brittle Hollow are examples of child entrie A rumor fact represents the information you might hear about a specific area or concept, usually, you get these through dialogue or maybe by observing a faraway planet. -![rumorFactExample](/ship_log/rumor_example.webp) +![rumorFactExample](@/assets/docs-images/ship_log/rumor_example.webp) ### Explore Facts Explore facts represent the information you learn about a specific area or concept. -![exploreFactExample](/ship_log/explore_example.webp) +![exploreFactExample](@/assets/docs-images/ship_log/explore_example.webp) ## The XML @@ -180,7 +180,7 @@ For example, if I want to change an entry with the ID of `EXAMPLE_ENTRY` and ano To help with this, download the unity explorer mod and manually position entries (they're located under `Ship_Body/Module_Cabin/Systems_Cabin/ShipLogPivot/ShipLog/ShipLogPivot/ShipLogCanvas/MapMode/ScaleRoot/PanRoot`), then simply use the dev tools to dump all the entries to a json string you can copy and paste into your config. -![autoDetectiveMode](/ship_log/auto_rumor_mode.webp) +![autoDetectiveMode](@/assets/docs-images/ship_log/auto_rumor_mode.webp) _A set of entries laid out with auto mode_ ### Images @@ -228,7 +228,7 @@ Colors for each curiosity is given in a list **within the star system config**, } ``` -![curiosityColorChange](/ship_log/change_color.webp) +![curiosityColorChange](@/assets/docs-images/ship_log/change_color.webp) _The curiosity's color is changed to blue_ ## Map Mode Options @@ -246,7 +246,7 @@ those planets are put in a column, then, each planet orbiting _those_ planets ar are. The order of each planet is determined by their semi-major axis, if two planets have the same semi-major axis then they're sorted by order loaded in. -![autoMapMode](/ship_log/auto_map_mode.webp) +![autoMapMode](@/assets/docs-images/ship_log/auto_map_mode.webp) _An example system laid out with auto mode_ ##### Offset @@ -318,7 +318,7 @@ second row (you can't select the sun, so it doesn't have a row or column). So, b We say this planet is to the right of the sun station (putting in a position that is already occupied will override what is in that position). -![navigationIndices](/ship_log/map_indices.webp) +![navigationIndices](@/assets/docs-images/ship_log/map_indices.webp) ##### Overriding Vanilla Planets @@ -544,4 +544,4 @@ Adding an entry location is similar to adding a Reveal Volume: } ``` -![entryLocationExample](/ship_log/entry_position.webp) +![entryLocationExample](@/assets/docs-images/ship_log/entry_position.webp) diff --git a/docs/src/content/docs/guides/star-systems.md b/docs/src/content/docs/guides/star-systems.md index 3bacf4df..f33423bd 100644 --- a/docs/src/content/docs/guides/star-systems.md +++ b/docs/src/content/docs/guides/star-systems.md @@ -39,10 +39,10 @@ To see all the different things you can put into a config file check out the [St You can warp to custom star systems via the Nomai vessel. Each coordinate has to be 2-6 points long. These are the points for each coordinate node. When making your unique coordinate you should only use each point once. -![nomaiCoordinateIndexes](/star_systems/nomai_coordinate_indexes.webp) +![nomaiCoordinateIndexes](@/assets/docs-images/star_systems/nomai_coordinate_indexes.webp) ### Hearthian Solar System Vessel Coordinates You can use these coordinates to warp back to the hearthian solar system. -![hearthianSolarSystemCoordinates](/star_systems/hearthian_solar_system_coordinates.webp) +![hearthianSolarSystemCoordinates](@/assets/docs-images/star_systems/hearthian_solar_system_coordinates.webp) diff --git a/docs/src/content/docs/start-here/getting-started.md b/docs/src/content/docs/start-here/getting-started.md index e1c6e571..82bf1e16 100644 --- a/docs/src/content/docs/start-here/getting-started.md +++ b/docs/src/content/docs/start-here/getting-started.md @@ -20,7 +20,7 @@ Making an entirely separate addon can get a little complicated, so New Horizons To get started, navigate to your mod manager and click the ⋮ symbol, then select "Show In Explorer". -![Select "Show in explorer"](/getting_started/mod_manager_show_in_explorer.webp) +![Select "Show in explorer"](@/assets/docs-images/getting_started/mod_manager_show_in_explorer.webp) Now, create a new folder named "planets". As the name suggests, New Horizons will search the files in this folder for planets to generate. diff --git a/docs/tsconfig.json b/docs/tsconfig.json index 418a1a1d..0cf7790e 100644 --- a/docs/tsconfig.json +++ b/docs/tsconfig.json @@ -1,3 +1,9 @@ { - "extends": "astro/tsconfigs/strict" + "extends": "astro/tsconfigs/strict", + "compilerOptions": { + "baseUrl": ".", + "paths": { + "@/*": ["src/*"] + } + } }