Vampirism for Minecraft 1.21- Latest branch
Mod Description
Vampires are fast, strong and bloodthirsty entities, which do not like the sun, but don't fear the night, and the best thing is: You can become one!
This mod allows you to become a vampire with all its benefits and drawbacks.
After being bitten by a vampire or manually injecting some vampire blood you get an effect called "Sanguinare Vampiris" which eventually turns you into a vampire.
For a more detailed description head over to the Minecraft Forum or the Curseforge page.
Links
Issues
https://github.com/TeamLapen/Vampirism/issues Please use the appropriate template when creating an issue.
The following labeling scheme is used:
- unconfirmed: Awaiting triage or bug not reproduced yet
- discussion: Looking for feedback
- enhancement: Any minor tweak that can be introduced in minor releases
- feature: Any change that takes more time to implement and test
- accepted: Any feature/enhancement that is planned to be implemented eventually
- *1.12-1.***: Affecting only a specific MC version
- *v1.8-v1.**: Bug affecting or enhancement targeting a specific Vampirism release branch
- latest: Bug affecting or enhancement targeting the latest (potentially unreleased) Vampirism branch
People
- maxanier
- Cheaterpaul
- lunofe Triage/Support/Community/Official Server/Art
- Piklach Community/Official Server
Special Thanks to
- PendragonII Community/Official Server
- TheRebelT Models/Textures
- TinkerHatWill Textures
- Alis Textures
- dimensionpainter Textures
- S_olace Textures
- Mistadon Code/Models
- wildbill22 Code
- LRA_10 Models/Textures
- Oreo365 Models
- Slippingchip400 Models
- Йода Textures
- XxKidDowdallxX Textures
- F_Spade Textures
- Matheo Lore
- special_krab Lore
- cournualllama2 Lore
- Random Textures/Models
- Shumnik Textures/Models
- BugraaK Textures/Models
- MrVityaTrash Textures
- FrostedOver Textures
- Grid Textures
- T_Corvus Textures
API
Vampirism has an API you can use to add blood values to your mod's creatures or make them convertible and more. For more information and an overview checkout the wiki https://wiki.vampirism.dev/docs/api/intro.
Setup Gradle build script
Use Vampirism in your development environment
You should be able to include it with the following in your `build.gradle`: ```gradle repositories { //Maven repo for Vampirism maven { url = "https://maven.maxanier.de/releases" } } dependencies { //compile against the Vampirism API compileOnly fg.deobf("de.teamlapen.vampirism:Vampirism:${mc_version}-${vampirism_version}:api") //at runtime (in your development environment) use the full Vampirism jar runtimeOnly fg.deobf("de.teamlapen.vampirism:Vampirism:${mc_version}-${vampirism_version}") } ``` #### Choose a version `${mc_version}` gets replaced by the current Minecraft version. (i.e. `1.20.4`) `${vampirism_version}` gets replaced by the version of Vampirism you want to use (i.e `1.10.0`) For a list of available Vampirism version, see [CurseForge](https://www.curseforge.com/minecraft/mc-mods/vampirism-become-a-vampire) or the [maven listing](https://maven.maxanier.de/de/teamlapen/vampirism/Vampirism/) . These properties can be set in a file named `gradle.properties`, placed in the same directory as your `build.gradle` file. Example `gradle.properties`: ``` mc_version=1.16.5 vampirism_version=1.7.12 ``` #### Rerun Gradle setup commands Please run the commands that you used to set up your development environment again. E.g. `gradlew` or `gradlew build --refresh-dependencies` Refresh/Restart your IDE afterwards. #### Run Vampirism in a deobfuscated environment Vampirism uses **mixins**. To be able to apply them in a deobfuscated environment using a different set of mappings ( from the one Vampirism uses) you have to enable remapping the refmap: Add ``` property 'mixin.env.remapRefMap', 'true' property 'mixin.env.refMapRemappingFile', "${projectDir}/build/createSrgToMcp/output.srg" ``` to your run configurations in your `build.gradle` and then regenerate your IDE run configurations (`genIntelliJRuns` or similar). If that does not work you can also try `property 'mixin.env.disableRefMap', 'true'` If you still run into issues with the mixins you can also set `mixin.env.ignoreRequired` to `true`. However, not all of Vampirism will work correctly then. #### Examples Checkout this example project: https://github.com/TeamLapen/VampirismAPIExample If you want to create an addon which access all of Vampirism's classes, not just the API, checkout this https://github.com/TeamLapen/VampirismAddonExample and consider contacting @Cheaterpaul.Code Structure
The _minecraftversion branch serves as the main development branch. There might be older (stable) branches for the
same MC version suffixed with the Vampirism main version.
It may receive bugfixes until the latest branch is released.
The source code is currently divided into three parts, which might be split in the future.
Vampirism
Located in de.teamlapen.vampirism
Contains the mod source code. Depends on the other two parts.
Vampirism API
Located in de.teamlapen.vampirism.api
Designed to be used by mods that only optionally interact with Vampirism as well as addon mods depending on Vampirism.
VampLib/TeamLapen Lib
Located in de.teamlapen.lib
Independent mod (Contains @Mod).
Provides Helpers and Registries to automate stuff like EntityUpdates.
Provides abstract classes/default implementations/interfaces to simplify things (located under de.teamlapen.lib.lib).
Setting up the development environment
old / outdated
If you would like to compile your own versions or even contribute to Vampirism's development, you need to set up the dev environment like any other mod.Code Style
The code style used in this project is the IntelliJ default one.
License
The source code and text in this repository are licenced under LGPLv3 except for the following parts:
Textures
Any textures included in this mod are licenced under the following terms:
Any textures (and models) included in the mod may be used, remixed and distributed for anything related to Vampirism (fan art, addon mods, forks, reviews, ...) excluding resource packs.
If you want to use them in a resource/texture pack, you must credit the Vampirism project or the individual creator where applicable and it must not be used commercially.
Sounds
The sounds used in this mod are individual licensed and may only be used outside Vampirism under the respective licensing terms if noted as such.
| Sound | Creator | Link | License |
|---|---|---|---|
| DST-VampireMonk.mp3 | Striderjapan | freesound | CC Attribution |
| vampire bites | Bernuy | freesound | CC Attribution |
| bow02.ogg | Erdie | freesound | CC Attribution |
| the swarm v31m3 | Setuniman | freesound | CC Attribution |
| Boiling Towel | unfa | freesound | CC Attribution |
| Pepper mill grinds pepper | Black_River_Phonogram | freesound | CC0 |
| Slimey | Nebulasnails | freesound | CC0 |
| blood_sucker | Bernuy | freesound | CC Attribution |
| Organ Ambience, Calm, A | InspectorJ | freesound | CC Attribution |
Sit functionality - sit package
The code under de.teamlapen.vampirism.sit is adapted from bl4ckscor4's Sit mod and licensed under GNU GPLv3 (see
LICENSE.txt in that directory).
Radial screen - lib.*.radialmenu package
The code under de.teamlapen.lib.lib.client.gui.screens.radialmenu is adapted from David Quintana's Radial Menu and
licensed under the terms of the LICENSE.txt file in that directory.