Skip to content

Commit 75ba60e

Browse files
thebrightsparkthebrightspark
authored
Merge pull request #1 from thebrightspark/software+shaders
README, software and shaders
1 parent 8f13f98 commit 75ba60e

11 files changed

Lines changed: 100 additions & 35 deletions

File tree

‎.vitepress/config.mts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ export default defineConfig({
2323

2424
sidebar: [
2525
{ text: 'Downloads', link: '/download' },
26+
{
27+
text: 'Usage',
28+
items: [
29+
{ text: 'Lighting Software', link: '/usage/software' },
30+
{ text: 'Shaders', link: '/usage/shaders' }
31+
]
32+
},
2633
{
2734
text: 'Fixtures',
2835
items: [

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Theatrical Wiki
2+
3+
Repo for the wiki that can be found at https://theatricalmod.dev/
4+
5+
## Run Locally
6+
7+
To run this locally (intended for testing changes for contributions), ideally install and use NVM to install Node v24
8+
and NPM.
9+
Then within the root of this project run `npm install` (installs dependencies) and then `npm docs:dev` (runs the docs).
10+

‎package-lock.json‎

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/download.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,11 @@ Theatrical is available from both CurseForge and Modrinth - you can find the rel
99
<div class="button-list">
1010
<VPButton tag="a" size="medium" text="CurseForge" theme="brand" href="https://www.curseforge.com/minecraft/mc-mods/theatrical/files/all?page=1&pageSize=20&showAlphaFiles=show" />
1111
<VPButton tag="a" size="medium" text="Modrinth" theme="modrinth" href="https://modrinth.com/mod/theatrical/versions" />
12-
</div>
12+
</div>
13+
14+
If you're interested in some more fixtures, you can find a community addon called Theatrical Extra Lights:
15+
16+
<div class="button-list">
17+
<VPButton tag="a" size="medium" text="CurseForge" theme="brand" href="https://www.curseforge.com/minecraft/mc-mods/theatrical-extra-lights" />
18+
<VPButton tag="a" size="medium" text="Modrinth" theme="modrinth" href="https://modrinth.com/mod/theatrical-extra-lights" />
19+
</div>

‎src/fixtures/led_fresnel.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Channel Count: 4
44

5-
| Attribute | Channel |
6-
| ------------- | ------------- |
7-
| Intensity | 1 |
8-
| Red | 2 |
9-
| Green | 3 |
10-
| Blue | 4 |
5+
| Attribute | Channel |
6+
|-----------|---------|
7+
| Intensity | 1 |
8+
| Red | 2 |
9+
| Green | 3 |
10+
| Blue | 4 |

‎src/fixtures/led_panel.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Channel Count: 4
44

5-
| Attribute | Channel |
6-
| ------------- | ------------- |
7-
| Intensity | 1 |
8-
| Red | 2 |
9-
| Green | 3 |
10-
| Blue | 4 |
5+
| Attribute | Channel |
6+
|-----------|---------|
7+
| Intensity | 1 |
8+
| Red | 2 |
9+
| Green | 3 |
10+
| Blue | 4 |

‎src/fixtures/moving_light.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Channel Count: 7
44

5-
| Attribute | Channel |
6-
| ------------- | ------------- |
7-
| Intensity | 1 |
8-
| Red | 2 |
9-
| Green | 3 |
10-
| Blue | 4 |
11-
| Focus | 5 |
12-
| Pan | 6 |
13-
| Tilt | 7 |
5+
| Attribute | Channel |
6+
|-----------|---------|
7+
| Intensity | 1 |
8+
| Red | 2 |
9+
| Green | 3 |
10+
| Blue | 4 |
11+
| Focus | 5 |
12+
| Pan | 6 |
13+
| Tilt | 7 |

‎src/fixtures/moving_wash.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Channel Count: 7
44

5-
| Attribute | Channel |
6-
| ------------- | ------------- |
7-
| Intensity | 1 |
8-
| Red | 2 |
9-
| Green | 3 |
10-
| Blue | 4 |
11-
| Focus | 5 |
12-
| Pan | 6 |
13-
| Tilt | 7 |
5+
| Attribute | Channel |
6+
|-----------|---------|
7+
| Intensity | 1 |
8+
| Red | 2 |
9+
| Green | 3 |
10+
| Blue | 4 |
11+
| Focus | 5 |
12+
| Pan | 6 |
13+
| Tilt | 7 |

‎src/fixtures/redstone_interface.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Outputs redstone based on the Intensity DMX channel. 255 is 15 redstone output,
44

55
Channel Count: 1
66

7-
| Attribute | Channel |
8-
| ------------- | ------------- |
9-
| Intensity | 1 |
7+
| Attribute | Channel |
8+
|-----------|---------|
9+
| Intensity | 1 |

‎src/usage/shaders.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<script setup>
2+
import VPButton from 'vitepress/dist/client/theme-default/components/VPButton.vue';
3+
</script>
4+
5+
# Shaders
6+
7+
Generally many in the Theatrical like to specifically use one particular mod called Shimmer, which adds colored
8+
lighting to Minecraft - and Theatrical has support for it!
9+
10+
<div class="button-list">
11+
<VPButton tag="a" size="medium" text="CurseForge" theme="brand" href="https://www.curseforge.com/minecraft/mc-mods/shimmer" />
12+
<VPButton tag="a" size="medium" text="Modrinth" theme="modrinth" href="https://modrinth.com/mod/shimmer!" />
13+
</div>
14+
15+
However, generally shaders aren't very compatible with Shimmer!
16+
Please see [their wiki here](https://github.com/Low-Drag-MC/Shimmer/wiki/Shader-Compatibility-Example) for extra info,
17+
and an example of adding support for BSL shaders.
18+
19+
There is a
20+
[support thread in the Theatrical Discord server here](https://discord.com/channels/481830554447118371/1321510430077878292)
21+
where you can find others working with getting Shimmer and shaders working together.

0 commit comments

Comments
 (0)