Home - Lythom/capsule GitHub Wiki
Bring your base! Capsules can capture a region containing any blocks or machines, then deploy and undeploy at will. Inspired by Dragon Ball capsules.
Table of contents generated with markdown-toc
The first capsule you will have access to is made of wood. It's size is 1x1x1 which enables the "instant mode".
"Wooden capsule" recipe
It means you can capture any block (ie. a chest or a crafting table) by right clicking it, then deploy and undeploy it instantly by right clicking again with the capsule in hand.
If right click open a GUI, try to capture from a distance or while sneaking.
To go bigger you need a capture base. This is where you can initialize a capsule with it's first content. You'll be able to capture the region on the top of it. Place it somewhere just below what you want to capture, or in a free space and build on top of it.
"Capture Base" recipe
Then you need to craft at least one empty capsule (the top item is a stone button) :
"Iron Empty Capsule" recipe, default capture size : 1x1x1
"Gold Empty Capsule" recipe, default capture size : 3x3x3
"DiamondEmpty Capsule" recipe, default capture size : 5x5x5
Obsidian (9x9x9) and Emerald (11x11x11) capsules also exists, check JEI !
- Right click : activate
- Right click while activated : throw the capsule.
- Once the content is captured, the capsule can be deployed or undeployed at will.
Click to see the Initial capture demo
Note that all the capsules can be dyed (affect the base color) and labeled (sneak + right click).
Usage :
- Deploy : Right click once to activate, right click again to throw at the preview positions (are ahead not aiming a block).
- Undeploy : Right click the "Deployed" capsule and the content will be stored again into the capsule, wherever it currently is.
- Label : Sneak + Right click to open the label editing screen.
You need more space ? Here is the upgrade recipe (only works with empty capsule) :
"capsule upgrade" recipe, default max upgrades : 10
You can add several Popped Chorus Fruit at a time.
Demo Upgrade
It's highly recommanded that you create a recovery capsule and place it in a safe place ! If the capsule is lost (thrown in lava, on a cactus (…), at an impossible death location) a recovery capsule will allows you to get back the content.
"Recovery capsule" recipe
This mod also adds a unique enchantment : Recall.
Effect : whenever a recall enchanted item is dropped and touches the ground, it comes back into the thrower inventory after a last update. When in contact of water or lava the recall is immediate (prevent burning).
This enchant is intended to be used on capsules. Without this enchantment you have to pick up the thrown capsule manually. It can as well be applied on any enchantable item by configuration (disabled by default). Can be useful to fight against inventory dropping monsters or to prevent unintentional drop.
Blueprints capsule can be reloaded in order to deploy several times the same structure. You can link an inventory with sneak + right click to use it a source of building materials.
When unloaded, left click in the air to load from linked inventory and player inventory. If all materials are available they will be consumed to charge the capsule. Else, missing materials will be displayed. You can also Right click to undo the last deployment.
When loaded :
- Right click to deploy
- Left click to rotate
- Sneak + Left click to mirror
See https://imgur.com/gallery/vN1sJrf for a showcase.
Overpowered capsules can capture blocks that cannot be captures with standard capsules. Blocks that can be captured only by overpowered capsules can be configured in capsule.cfg by adjusting the excludedBlocks for standard and op capsules. By default the config is :
# List of block ids that will never be captured by a non overpowered capsule. While capturing, the blocks will stay in place.
S:excludedBlocks <
minecraft:bedrock
minecraft:mob_spawner
minecraft:end_portal
minecraft:end_portal_frame
minecraft:air
minecraft:structure_void
ic2:te
>
# List of block ids that will never be captured even with an overpowered capsule. While capturing, the blocks will stay in place.
S:opExcludedBlocks <
minecraft:air
minecraft:structure_void
ic2:te
>
That means that by default a standard capsule cannot capture bedrock, mob spawners or end portals whereas overpowered capsules can. OP Capsules can be crafted using a netherstar instead of an ender pearl.
Overridable blocks are blocks that would just be delete if on the path of a capsule deployment like grass or snow.
- Before 1.20.1 there is an entry in the config to list the materials and blocks that are overridable by capsules.
- Since 1.20.1, the config entry doesn't exists anymore and is replaced by the tag
capsule:overridable
to apply on the materials. Défault value :
// file:capsule/src/main/resources/data/capsule/tags/blocks/overridable.json
{
"replace": false,
"values": [
"#minecraft:leaves",
"#minecraft:replaceable",
"#minecraft:snow"
]
}
About rotations
Standard capsules can be rotated and mirrored by players using left click / shift+left click while previewing deloyment. All vanilla blocks, tileEntities and non-living entities (minecarts,etc) are supported but modded tileEntities will prevent a rotation by default. This is to prevent messing with modded tileEntities that have specific considerations with their orientation that capsule cannot know.
The "canRotate" state might need to be updated when you first acquire a standard capsule (blueprints will always rotate), if rotation is locked and you think it should work, deploy and undeploy the capsule to update it and be able to rotate. If it still can't: there is a special block in the content that does not support rotation.
As a modpack maker, if you want capsule to still try to rotate some specific block, you can whitelist them for blueprints and it will allow the block both to rotate in regular capsules and be used in blueprints. Checkout the Blueprint whitelist section.
Will block X from mod Y work with capsules ?
If compatible with vanilla structure blocks : yes.
If not compatible with vanilla structure blocks : no.
Latest versions of capsule have been tested a lot with very good results, give it a try ! Don't forget to backup your saves anyway it's always good to have one.
Can I use in my modpack ?
Sure ! Please simply give a link to this page and mention Lythom as the mod author.
If any problem with the mod feel free to PM or to submit an issue https://github.com/Lythom/capsule/issues.
How to create capsules with custom structures to put in my pack ?
All the information is at https://github.com/Lythom/capsule/wiki/Modpack-making.
How to move my capsule from a world to new one?
- in the old world, have the capsule in hand and use the command :
/capsule fromHeldCapsule <someName>
(repeat for each capsule to move). It will create a file in config/capsule/rewards and give you a one-use capsule you can throw away. - [If the new world is on the same server you can skip this step] Copy the file from
<oldServer>/config/capsule/rewards/<someName>.nbt
to<newServer>/config/capsule/rewards/
- In the new world, use the command
/capsule giveLinked <someName>
(repeat for each capsule). It will create a standard capsule from the template.
[1.15+] If you don't have admin level and want to download the .nbt file from a remote server, you can use the command /capsule downloadTemplate
. It will copy the .nbt file of the currently held capsule in a "capsule_exports" folder inside minecraft instance directory. This might not work if the content is too big or if the content is not fetched yet (use right click to preview and force the download in this case).
Once you have the nbt file, you can copy it in <newServer>/config/capsule/rewards/
and do step 3.
1.7.10 version ?
Capsule now rely on structure blocks mechanics, so I'll only maintain 1.10+ versions.
Is this open source ?
Yes, there : https://github.com/Lythom/capsule.
Code, Textures and binaries are licensed under the MIT License.
I have another question !
You can get help either to use capsule mod as a player, or to configure it into your modpack via the following channels :
- Github issues: https://github.com/Lythom/capsule/issues
- Discord server: https://discord.gg/wZpBVdr