|
1 | | -<p align="center"> |
2 | | -<img src="icon_big.png" width="512" height="512"> |
3 | | -</p> |
4 | | -<h1 align="center"> |
5 | | -Valkyrien Skies : Addon Template |
6 | | -</h1> |
7 | | -<p align="center"> |
8 | | -The official VS Addon template, for VS <b>2.4.0</b> and onward! |
9 | | -</p> |
10 | | - |
11 | | -## Getting Started |
12 | | -### Namespace / Mod ID |
13 | | -This template's default namespace/mod ID is "vs_template"- you'll likely want to change this! |
14 | | - |
15 | | -You can do so by altering the following files: |
16 | | -- Change the base package name in `settings.gradle.kts` |
17 | | -- Change the name and id variables in `gradle.properties` |
18 | | -- Change the MOD_ID in `VSTemplateMod.kt` in the `common` module |
19 | | -- Edit the `mods.toml` file in `src/main/resources/META-INF/` in the `forge` module |
20 | | -- Edit the `fabric.mod.json` file in `src/main/resources/` in the `fabric` module |
21 | | - |
22 | | -You should also rename anything prefixed with "VSTemplate" to your mod's name! |
23 | | - |
24 | | -If you are using IntelliJ, it is reccomended to refactor in your IDE rather than |
25 | | -changing the file name in file explorer, as it will automatically edit |
26 | | -the references to the old name to match your new one. |
27 | | - |
28 | | -### Understanding Dependencies |
29 | | -In this mod's `gradle.properties` file, you will find a few properties that define the versions of |
30 | | -each dependency this project has, including VS2 and its core. You can change these properties to update |
31 | | -dependency versions easily across the entire project, without having to edit buildscripts! |
32 | | - |
33 | | -Most dependencies have some easy way to discover the latest/reccomended version to depend on. |
34 | | -Valkyrien Skies itself is similar! The `vs_core_version` property should be equal to the identically named property in the [Valkyrien Skies Github Repo](https://github.com/ValkyrienSkies/Valkyrien-Skies-2), |
35 | | -and the `vs2_version` is the mod version, followed by the <b>first 10 characters</b> of the latest commit hash. |
36 | | - |
37 | | -You can find the most recent |
38 | | -retrievable version of VS easily by going to the Packages tab for [Fabric](https://github.com/ValkyrienSkies/Valkyrien-Skies-2/packages/2020982) or [Forge](https://github.com/ValkyrienSkies/Valkyrien-Skies-2/packages/2020984)! |
39 | | - |
40 | | -### Building and Running |
41 | | -Before running the mod after each change made, it is recommended to run the `./gradlew clean` task in your command line, followed by clicking the sync button in the top right. |
42 | | -This ensures the files built are up to date with your code changes. |
43 | | - |
44 | | -Alternatively to gradle clean, you can also manually delete your build folders. This is helpful if that task fails, for whatever reason. |
45 | | - |
46 | | -### Mod Structure |
47 | | -This mod template uses a multiloader structure, with 3 modules: |
48 | | -- `common` : This module contains code shared between both Fabric and Forge. This is where the majority of your mod's code should go! |
49 | | -- `fabric` : This module contains code specific to the Fabric loader. This includes the Fabric mod initializer, and any Fabric-specific implementations of common code. |
50 | | -- `forge` : This module contains code specific to the Forge loader. This includes the Forge mod class, and any Forge-specific implementations of common code. |
51 | | - |
52 | | -Within each module, you will find 3 primary submodules: |
53 | | -- `src/main/java` : This is where Java code goes. This is primarily used for Mixins, as Mixins cannot be written in Kotlin. You may also choose to relocate your primary mod files here, and not use Kotlin at all if you wish. |
54 | | -- `src/main/kotlin` : This is where Kotlin code goes. VS is primarily written in Kotlin, so it tends to be easier to work with VS when also writing in Kotlin. |
55 | | -- `src/main/resources` : This is where resources go, such as Forge's `mods.toml`, Fabric's `fabric.mod.json`, mod assets, and data files. |
56 | | - |
57 | | -### Using the VS Api |
58 | | -You can access the VS Core Api statically through `ValkyrienSkies.api` (with parenthesis for a method call in Java). The API's javadocs contain tons of extra information on how to use each part of it, so give them a read! |
59 | | - |
60 | | -Additionally, there are a few features in VS2 itself- such as `BlockEntityPhysicsListener`- that you may want to use. |
61 | | - |
62 | | -<i>This template was built for Valkyrien Skies 2.4.0+. Changes in API from 2.3 will make it almost certainly not function with releases of the mod prior to 2.4, so make sure you intend to develop for that version!</i> |
| 1 | + |
| 2 | + |
| 3 | + |
| 4 | +# Valkyrien Pirates |
| 5 | +This mod adds pirate ships to your world which sail of their own accord. These ships come with a fearsome crew, and cannons which will shoot at your ship. Killing the pirates will disarm the cannons, leaving the ship and its booty free for you to plunder!! |
| 6 | + |
| 7 | +<img src="https://cdn.modrinth.com/data/jv8hXuHT/images/61390e97a94c08814abce579afc76a209fbfd843.png" alt="drawing" width="400"/> |
| 8 | + |
| 9 | +## Ships |
| 10 | +Pirate ships generate as structures and are assembled by a Motion Invoking Block (unobtainable in survival) once within simulation distance. This block will drive the ship in a pattern - by default in a circle. |
| 11 | + |
| 12 | +Pirates that spawn on ships have a special property: some pirates are designated as cannoneers or helmsmen. Killing a cannoneer will stop its cannon from auto-firing, and killing the helmsman will replace the ship's Motion Invoking Block with Spruce Planks. |
| 13 | + |
| 14 | +<img src="https://cdn.modrinth.com/data/jv8hXuHT/images/c35e72fce832c6035cb9074b4588fbc69cd6c9c7.jpeg" alt="drawing" width="400"/> |
| 15 | + |
| 16 | +## Cannons |
| 17 | +To combat these pirate ships, you will likely want to bring your own cannons! Cannons can be created by placing a **Cannon Activator Block** behind a Dispenser. This will convert the dispenser into a **Cannon Dispenser**, letting you fire **Cannonballs** from it. To shoot a cannon, power the Cannon Activator Block (back of cannon) with a redstone signal. |
| 18 | + |
| 19 | +## Crafting |
| 20 | +The Cannon Activator Block can be crafted with the same recipe as a Dispenser, except with Gunpowder instead of Redstone Dust. |
| 21 | + |
| 22 | +Cannonballs can be crafted with Blaze Powder, Gunpowder, and an Iron Ingot in any pattern. |
| 23 | + |
| 24 | +## Crew |
| 25 | +You may find some friendlier pirates on a raft at sea, giving one a Golden Apple will allow you to arm your cannons, so they might autofire again! |
| 26 | + |
| 27 | +## Shipwrecks |
| 28 | +Shipwreck structures can be found throughout the world that contain treasure similar to what you can find on pirate ships. |
| 29 | + |
| 30 | +## Credits |
| 31 | +- Acrogeneous - Original author and fearless captain |
| 32 | +- G_Mungus - Author and cunning quartermaster |
| 33 | +- Ankiolyne - Artist and tactful navigator |
| 34 | +- Qoissant - Author and inspired ship architect |
0 commit comments