Project Essentials

Documentation for Project Essentials users, describing commands, permissions and API methods and other.

How to Install

For start the modification, you need installed Forge, it is desirable that the version matches the supported versions. You can download Forge from the link. Move the downloaded mod to the mods folder (installation example below).

.
├── assets
├── config
├── libraries
├── mods (that's how it should be)
│   ├── Project Essentials Core-MOD-1.14.4-1.X.X.jar (mandatory)
│   ├── Project Essentials Cooldown-1.14.4-1.X.X.jar (recommended)
│   ├── Project Essentials Permissions-1.14.4-1.X.X.jar (mandatory)
│   └── Project Essentials-1.14.4-1.X.X.jar
└── ...

Dependencies

Also do not forget to install dependencies, only two types of dependencies: mandatory (game will not start without a mod) and recommended (without a mod, game can start, but I recommend using it).

Download dependencies: Cooldown · Core · Permissions

One more step

Now try to start the game, go to the mods tab, if this modification is displayed in the mods tab, then the mod has been successfully installed.

Commands and Permissions

Some description of the commands was copied from https://essinfo.xeya.me/commands.html

Command name	Aliases	Permission	Op level	Description
/fly	/efly	ess.fly	~	Enable fly for you. If command executed with argument then for target player.
/god	/egod, /tgm	ess.god	~	Enable god mode for you. If command executed with argument then for target player.
/afk	/eafk, /away, /eaway	ess.afk	~	Marks you as away-from-keyboard.
/break	/ebreak	ess.break	~	Breaks the block you are looking at.
/burn	/eburn	ess.burn	~	Set a player on fire.
/lightning	/elightning, /shock, /eshock, /thor, /ethor	ess.lightning	~	Lightning strike target player.
/more	/emore, /dupe	ess.more	~	Fills the item stack in hand to maximum size.
/ping	/eping	ess.ping	~	Pong!
/repair	/erepair, /fix, /efix	ess.repair	~	Repairs the durability of one or all items.
/sendpos	/esendpos	ess.sendpos	~	Send your positions to target player.
/suicide	/esuicide	ess.suicide	~	Bruh ...
/air	/eair	ess.air	~	Restore your or target player air reserves.
/feed	/efead, /eat, /eeat	ess.feed	~	Satisfy the hunger.
/heal	/eheal	ess.heal	~	Heals you or the given player.
/getpos	/eposition, /mypos	ess.getpos	~	Sent you your position or the given player.
/essentials	/essentials version	ess.version	~	Sent you in chat essentials version (about).
/essentials reload	none	ess.reload	~	Reload essentials configurations without saving.
/essentials save	none	ess.save	~	Save essentials configurations.
/top	/etop	ess.top	~	Teleport to the highest block at your current position.
/tpaall	/etpaall, /callall, /ecallall	ess.tpaall	~	Requests all players online to teleport to him.
/tpacancel	/etpacancel	ess.tpacancel	~	Cancel your all teleport requests.
/tpaccept	/etpaccept, /tpyes, /etpyes	ess.tpaaccept	~	Accept last teleport request.
/tpa	/etpa, /call, /ecall	ess.tpa	~	Request to teleport to the specified player.
/tpahere	/etpahere, /callhere, /ecallhere	ess.tpahere	~	Request that the specified player teleport to you.
/tpall	/etpall	ess.tpall	~	Teleport all online players to another player.
/tpdeny	/etpdeny, /tpno, /etpno	ess.tpdeny	~	Reject a teleport request.
/tphere	/etphere, /s	ess.tphere	~	Teleport a player to you.
/tppos	/etppos	ess.tppos	~	Teleport to coordinates.
/tptoggle	/etptoggle, /tpoff, /etpoff	ess.tptoggle	~	Blocks all forms of teleportation requests.
/day	/eday	ess.day or ess.time	~	Change the world time to day.
/midnight	/emidnight	ess.midnight or ess.time	~	Change the world time to midnight.
/night	/enight	ess.night or ess.time	~	Change the world time to night.
/noon	/enoon, /midday, /noonday	ess.noon or ess.time	~	Change the world time to noon.
/sunrise	/esunrise, /dawn, /morning, /morn	ess.sunrise or ess.time	~	Change the world time to sunrise.
/sunset	/esunset, /dusk, /sundown, /evening	ess.sunset or ess.time	~	Change the world time to sunset.
/rain	/erain	ess.rain or ess.weather	~	Change the world weather to rain.
/storm	/estorm, /thunder, /ethunder, /goodweather	ess.storm or ess.weather	~	Change the world weather to storm.
/sun	/esun, /weatherclear, /clearsky, /sky, /esky	ess.sun or ess.weather	~	Change the world weather to clear.

Configuration

User Data configuration

Configuration description

The configuration stores player data. For example, the world in which he was before leaving the game, or whether the flight mode is enabled on his account.

Configuration location

.minecraft/config/ProjectEssentials/user-data/{uuid}/data.json

Default configuration

{
    "lastWorld": "",
    "lastWorldPos": "",
    "flyEnabledInWorlds": [],
    "godEnabledWorlds": []
}

Configuration documentation

Property	Type	Description
lastWorld	String	Last world (using full name, e.g New World&minecraft:overworld). Symbol & uses as split char.
lastWorldPos	String	Last player position in world (includes only x, y, z axis), e.g -380, 65, -1139
flyEnabledInWorlds	List<String>	Contains world names in which enabled fly mode (basically needed for automatically fly enabling). e.g New World.
godEnabledWorlds	List<String>	Contains world names in which enabled god mode (basically needed for automatically god enabling). e.g New World.

Commands configuration

Configuration description

This configuration stores the settings for almost all the commands that the Project Essentials module provides. You can customize command aliases. There are specific settings for some commands, for example for the /feed or/tpa command.

Configuration location

.minecraft/config/ProjectEssentials/commands.json

Default configuration

Oh. The configuration is large. If you want to get the default configuration, just delete it and after restarting the modification it will be created again.

Configuration documentation (for common properties)

Property	Type	Description
Commands	List<Command>	Stores all commands.
Heal, Feed and other	Command	Just command with some options.
EnableArgs	Boolean	If value true then arguments for command will be enabled.
Aliases	List<String>	Contain all command aliases.

Configuration documentation (specific properties)

Property	Type	Description
Feed.MaxFoodSaturationLevel	Float	The saturation level that will be obtained when the command is executed.
Feed.MaxFoodLevel	Int	The food level that will be obtained when the command is executed.
Fly.AutoFlyEnabled	Boolean	If value true then auto fly in world or server will be enabled.
Fly.FlyDisabledWorlds	List<String>	World names in which disabled fly mode.
God.AutoGodModeEnabled	Boolean	If value true then auto god mode in world or server will be enabled.
God.GodModeDisabledWorlds	List<String>	World names in which disabled god mode.
Break.RestrictedBlocks	List<String>	Contains all restricted blocks for breaking by command.
Rain\Storm.DefaultDuration	Int	Default duration for weather event. (probably in Minecraft ticks ¯\_(ツ)_/¯)
Burn.DefaultDuration	Int	Default duration player firing. (also probably in Minecraft ticks ¯\_(ツ)_/¯)
Tpa.TimeOut	Int	Time out for teleport request in seconds.

If you have any questions or encounter a problem, be sure to open an issue