Skip to content

Commit

Permalink
Improved the wiki experience
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeryn99 committed Nov 30, 2024
1 parent d9825d4 commit 4ca4e96
Show file tree
Hide file tree
Showing 14 changed files with 187 additions and 10 deletions.
Binary file added Writerside/images/compat_immersive_portals.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/curios_compat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/trinkets_compat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions Writerside/topics/Compatiblity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Compatibility

While writing mods, it can be very hard to predict what a different that isn't written by you is going to do!
This can cause crashes, unexpected behaviour and stop game progression, which is something we wish to avoid

If you have run into an issue with a mod while using Tardis Refined, report it to us [here](https://github.com/WhoCraft/TardisRefined/issues) and we will investigate it, attempt to sort it and try and point you in the right direction

- [Curios](ExtendedInventoryMods.md#curios)
- [Trinkets](ExtendedInventoryMods.md#trinkets)
- [Immersive Portals](Portals.md)
- [Diagonal Windows](Diagonal-Blocks-Windows-Walls.md#diagonal-windows)
- [Diagonal Walls](Diagonal-Blocks-Windows-Walls.md#diagonal-walls)
- [Performance Mods](Shaders.md)



19 changes: 19 additions & 0 deletions Writerside/topics/Diagonal-Blocks-Windows-Walls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Diagonal Blocks (Windows, Walls)

When developing the mod in 1.19.2, we had some users baffled as to why their Astral Manipulator recipes weren't crafting even though they had the exact blocks they needed...
When investigating, we found that when Tardis Refined was installed with any of ny of the Diagonal X mods, it would replace the Vanilla block and cause crafting problems!

After some communication of the Developer of that mod, we were advised of a fix which was implemented for [Diagonal Walls](https://www.curseforge.com/minecraft/mc-mods/diagonal-walls) and [Diagonal Windows](https://www.curseforge.com/minecraft/mc-mods/diagonal-windows)

You can now craft without any interruptions!

### Diagonal Walls
> [Modrinth](https://modrinth.com/mod/diagonal-walls)
> [Curse](https://www.curseforge.com/minecraft/mc-mods/diagonal-walls)
### Diagonal Windows
> [Modrinth](https://modrinth.com/mod/diagonal-windows/versions)
> [Curse](https://www.curseforge.com/minecraft/mc-mods/diagonal-windows)
18 changes: 18 additions & 0 deletions Writerside/topics/ExtendedInventoryMods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Curios/Trinkets Compatibility

We understand that users don't always want to wear things like the mods [](AR-Glasses.md) while Piloting the TARDIS!

Therefore, we have added compatibility with [Curios](https://www.curseforge.com/minecraft/mc-mods/curios) and [Trinkets](https://modrinth.com/mod/trinkets/versions)



### Trinkets
![trinkets_compat.png](trinkets_compat.png)
> [Modrinth](https://modrinth.com/mod/trinkets/versions)
### Curios
![curios_compat.png](curios_compat.png)
> [Modrinth](https://modrinth.com/mod/curios)
> [Curse](https://www.curseforge.com/minecraft/mc-mods/curios)
13 changes: 13 additions & 0 deletions Writerside/topics/Portals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Immersive Portals

We understand our players like the feature of being able to view the outside of the TARDIS from the inside, and the inside of the TARDIS from the outside
With some additional help from [The Judge](https://github.com/thejudge156) we implemented support for Immersive Portals

![compat_immersive_portals.png](compat_immersive_portals.png)

### Notes
This compatibility is only present on Fabric versions of the Mod, in theory it would work for Forge in a limited capacity for the 1.20.1 version of the mod, but we have disabled this by default with no way for a player to turn it on. We feel there isn't a demand for the Forge version and the Forge Version of Immersive Portals isn't entirely official, making development rather delayed at times

> [CurseForge](https://www.curseforge.com/minecraft/mc-mods/immersive-portals-mod)
> [Modrinth](https://modrinth.com/mod/immersiveportals)
42 changes: 42 additions & 0 deletions Writerside/topics/Shaders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Performance Mods

Ah yes, performance mods! We are all guilty of using them!

Now, this is a difficult one to fix, as there is a number of tradeoffs that happen when playing with Performance Mods, one of which is that it drastically changes how the game renders things or how logic is handled!

This leads to an array of problems, sadly we can't fix these problems without actively fighting the reason you installed these mods!

So instead of talking about how we made it compatible, we will cover some things you may run into!


## Shaders leading to full bright consoles and shells

Follow these steps to integrate Tardis Refined with Complementary Shaders:

1. **Locate the Shaders Folder**
- Open the folder for Shaders in your Minecraft installation directory.

2. **Open the `shaders` Directory**
- Inside the shader pack, find and open the `shaders` directory.

3. **Find the `block.properties` File**
- Look for a file named `block.properties` (or something similar).

4. **Edit the `block.properties` File**
- Open the `block.properties` file using a suitable text editor (e.g., Notepad++ or VS Code).

5. **Search for "chest"**
- Locate the section of the file that references regular and trapped chests.

6. **Add Tardis Refined Entry**
- Add the following line to the same section, ensuring the format matches the existing entries:
```plaintext
tardis_refined:tardis_console
```
7. **Save and Test**
- Save the changes to the file and test the shaders in-game to ensure the Tardis Console appears as intended.
``Note``
: Every Shader is different, we cannot say if this will fix your issue for sure or if the Shader has the files we mention :(
5 changes: 4 additions & 1 deletion Writerside/topics/addons/coding/Datapack-Customisation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Datapack Customisation

Start typing here...
- [](Desktops.md)
- [](Hums.md)
- [](Console-Unit-Patterns.md)
- [](External-Shell-Patterns.md)
54 changes: 53 additions & 1 deletion Writerside/topics/addons/datapacks/Hums.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,55 @@
# Hums

To be documented.
Through the use of Datapacks, it is possible to implement custom soundscapes! (Also known as "Hums")

## Requirements
- A Resource Pack
- A Data Pack

## Resource Pack
Within your resourcepack, create custom sounds, you can learn how to do this [here](https://youtu.be/VIt0JsFklZI)

Once you have completed this step, you are done with the resource pack side of things!

## Data Pack

### File Structure
Console patterns follow the following structure:
```
* data
* [your_datapack_pack_namespace]
* tardis_refined
* hums
* [hum_name].json
```


Here is an example entry from the mod, you may edit to your needs!

```JSON
{
"ambient_sounds": [
"minecraft:ambient.crimson_forest.additions",
"minecraft:ambient.crimson_forest.mood"
],
"hum_sound": "minecraft:ambient.crimson_forest.loop",
"id": "tardis_refined:crimson_forest",
"name_component": "{\"color\":\"gold\",\"text\":\"Crimson Forest\"}"
}
```

``ambient_sounds``
: An array of sounds that will play at randomly and not continuously

``hum_sound``
: One sound entry that will play on a loop forever until the player changes hum

``id``
: String, Unique identifier for the hum.
: Examples: ``bables``, ``the_forbidden_lands``

``name_component``
: NBTComponent, Display Text for the UI.
: ONLY USE the Minecraft Tellraw generated text, DO NOT include the tellraw command syntax. <a href="https://www.minecraftjson.com/">You can find a generator here.</a>
: Example: ``{\"color\":\"gold\",\"text\":\"The Forbidden Lands!\"}``

11 changes: 6 additions & 5 deletions Writerside/topics/gameplay/Crafting-Recipes.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Crafting Recipes
# Crafting

Although several main devices are crafted by the Astral Manipulator, there are some still done by the crafting table.

Click to move on to the different recipes.

<a href="Astral-Manipulator-Recipes.md"/>
<br/>
<br/>
<a href="Crafting-Table-Recipes.md"/>
[](Astral-Manipulator-Recipes.md)

[](Crafting-Table-Recipes.md)





Expand Down
4 changes: 3 additions & 1 deletion Writerside/topics/gameplay/Piloting-the-TARDIS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

<img src="https://i.makeagif.com/media/3-19-2015/7vf78g.gif" preview-src="https://i.makeagif.com/media/3-19-2015/7vf78g.gif"/>


- [Controls](Controls.md)
- [Flight](Flight.md)
- [Computer Bank](Computer-Bank-Functions.md)
7 changes: 6 additions & 1 deletion Writerside/topics/gameplay/The-TARDIS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@

The following items discuss TARDIS functionalities.

![overgrown_root.png](overgrown_root.png)
![overgrown_root.png](overgrown_root.png)

- [](Locating-a-TARDIS-Seed.md)
- [](Your-TARDIS.md)
- [](Computer-Bank-Functions.md)
- [](The-Eye-of-Harmony-Power.md)
8 changes: 7 additions & 1 deletion Writerside/tr.tree
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
start-page="Getting-Started.md">

<toc-element topic="Getting-Started.md"/>
<toc-element topic="Astral-Manipulator-Crafting.md"/>
<toc-element topic="Crafting-Recipes.md">
<toc-element topic="Astral-Manipulator-Crafting.md"/>
<toc-element topic="Astral-Manipulator-Recipes.md"/>
<toc-element topic="Crafting-Table-Recipes.md"/>
</toc-element>
Expand Down Expand Up @@ -49,6 +49,12 @@
<toc-element topic="External-Shell-Patterns.md"/>
</toc-element>
</toc-element>
<toc-element topic="Compatiblity.md">
<toc-element topic="Shaders.md"/>
<toc-element topic="ExtendedInventoryMods.md"/>
<toc-element topic="Diagonal-Blocks-Windows-Walls.md"/>
<toc-element topic="Portals.md"/>
</toc-element>


<toc-element topic="Addon-Creation.md">
Expand Down

0 comments on commit 4ca4e96

Please sign in to comment.