commit 713b61e7f9cf4ad45bed0c05b8223f0ffda98cb1 Author: Resxt <55228336+Resxt@users.noreply.github.com> Date: Thu Oct 20 14:26:33 2022 +0200 Initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/README.md b/README.md new file mode 100644 index 0000000..41a1c21 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# Plutonium-T6-Scripts + +[![image](cover.jpg)](https://plutonium.pw/) + +## What is this? + +This is a collection of [Plutonium](https://plutonium.pw/docs/intro/) T6/BO2 scripts I created, written in [GSC](https://plutonium.pw/docs/modding/gsc/). + +Huge thanks to everyone who helped me learn GSC: Birchy, DoktorSAS, FutureRave and other people on Discord. + +## How do I download a script? + +### Compiled / Ready to use script + +To download a compiled script, click on a `.gsc` file that **doesn't** end with `-source` and click on `Download`. +
+ Image + + ![image](https://user-images.githubusercontent.com/55228336/196939333-85cc9f1f-4446-4421-b76d-e4a4d198fdb9.png) + ![image](https://user-images.githubusercontent.com/55228336/196939820-e278baa1-c02d-4e27-b4da-14308c83c851.png) +
+ +### Source script + +Alternatively, if you want to download the source code click on a `.gsc` file that ends with `-source` and click on `Raw`. + +
+ Image + + ![image](https://user-images.githubusercontent.com/55228336/196944459-de91a8a5-61f3-4cdc-9682-63af0b53f1fa.png) + ![image](https://user-images.githubusercontent.com/55228336/196945099-98f56acb-8150-4ef1-8ba2-17d943e8dbd2.png) +
+ +Right click anywhere and click on `Save page as` (or an equivalent). + +Make sure to put `All` or `Any` for the file type and to add `.gsc` at the end of the file name. + +
+ Image + + ![image](https://user-images.githubusercontent.com/55228336/196947110-4df947b8-e72e-45a6-a66d-30dcb5abb2f4.png) +
+ +## How do I use a compiled script? + +[Follow the instructions in the documentation](https://plutonium.pw/docs/modding/loading-mods/#loading-existing-scripts-on-t6) + +Simply drop a compiled `.gsc` file inside `%localappdata%\Plutonium\storage\t6\scripts`. + +Note that you can use `map_restart` in the [console](https://plutonium.pw/docs/opening-console/) to quickly restart your current game and reload scripts. + +## How do I compile a script? + + + +- Download [GSC Tool](https://github.com/xensik/gsc-tool/releases/latest) +- Read the [instructions to compile a file](https://github.com/xensik/gsc-tool#usage) + +It should look similar to this +`gsc-tool.exe comp t6 "C:\Users\Resxt\AppData\Local\Plutonium\storage\t6\scripts\mapvote.gsc"` + +If after opening the file you see that it has a lot of non readable characters this means that it was successfully compiled. + +## What are compiled and source scripts? + +Before downloading a script it's important to understand what compiled and source scripts mean. +A source script is the script in a human readable form (a text file), this is how the script is written. +A compiled script is simply a source script that has been compiled by an interpreter to make it readable by the game. +At the time of writing, T6 cannot read source scripts so you have to compile them to allow the game to read them. + +So if you only want to use a script and you don't want to edit a script or review its code you can simply [download a compiled script](#compiled--ready-to-use-script) and [start using it](#how-do-i-use-a-compiled-script). + +All of my scripts always come as two files: + +- script.gsc (compiled script) +- script-source.gsc (source script) diff --git a/cover.jpg b/cover.jpg new file mode 100644 index 0000000..c68331a Binary files /dev/null and b/cover.jpg differ