Skip to content

Commit bc040e2

Browse files
authored
Update README.md
1 parent f9a47e8 commit bc040e2

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
## WARNING: WIP
2-
A Minecraft mod currently in development that adds custom highway & street signs.
1+
![](https://cdn.modrinth.com/data/cached_images/d418f45c6a9a85c1d5f12821ec8440961ed9d8fd_0.webp)
2+
3+
## What is ClickSigns?
4+
ClickSigns is a simple fabric mod that lets you create custom highway & street signs. Even though the main focus is street signs, you can create any type of image that can dynamically have text on it ingame. Ideal for building cities and towns!
5+
- **Make your own road signs (Resourcepack Guide):** [Wiki](https://github.com/Clickism/ClickSigns/wiki/Making-Custom-Road-Sign-Templates)
6+
- *P.S: There will be more and more road signs added through regular updates & extensions*
7+
8+
## How to: Create & Edit Road Signs
9+
To craft a *Road Sign*, put **8 iron ingots** around **any sign**:
10+
11+
![](https://cdn.modrinth.com/data/cached_images/bfafe170b70044d731ce1383d4a43bfeecfef7ac.jpeg)
12+
13+
Then, place it on a wall, on iron bars or anywhere you'd like, then click on the road sign to access the edit menu:
14+
15+
![](https://cdn.modrinth.com/data/cached_images/d8eda3c79c84934a543928b75ed33aa12866c1a7.jpeg)
16+
17+
- Fill in your text like on the image.
18+
- Use the arrows to change between different variants (aka. color schemes) of this template.
19+
- Use the alignment buttons to change the alignment of the sign.
20+
- **Make sure to click CONFIRM once you're done.** *Your changes won't be saved if you don't.*
21+
- Click **Change Template** to browse through all the various templates.
22+
23+
## How to: Changing The Road Sign Template
24+
- After you click *Change Template*, you will be welcomed by this screen:
25+
26+
![](https://cdn.modrinth.com/data/cached_images/4c5b226a9012829ec5d9cd8fc5a57e2ba69f7bf0.jpeg)
27+
28+
- _On the left side_, you have a list of all the templates **you have installed.**
29+
- The templates are displayed in the format: *"Width x Height : Pack : Name : (Details)"*
30+
- _On the right side_, you have all the details regarding the selected template.
31+
- You can use the arrows to look at different variants here as well.
32+
- **Using Filters:** To use the filters, either click on the direction you want, or input the width/height you're searching. If you for example select both **Left** and **Forward**, it will only show you the sign templates that have both directions.
33+
34+
## How to: Custom Road Signs
35+
- You can't find a certain road sign template you want? Make it yourself!
36+
- The template system is fully modular and client-side through **resourcepacks!**.
37+
- That means, you can create or install custom resourcepacks to have access to new road sign templates. These don't have to be installed on the server, but other players would need to have the same resourcepack installed in order to see them.
38+
39+
## Contact & Feedback
40+
Contact me on GitHub: [Github/Clickism](https://github.com/Clickism/ClickSigns)
41+

0 commit comments

Comments
 (0)