https://github.com/5uso/Mod-Warnings

A Minecraft datapack that allows to configure warnings in case certain mods / settings are detected
https://github.com/5uso/Mod-Warnings

Last synced: 1 day ago
JSON representation

A Minecraft datapack that allows to configure warnings in case certain mods / settings are detected

• Host: GitHub
• URL: https://github.com/5uso/Mod-Warnings
• Owner: 5uso
• License: apache-2.0
• Created: 2021-04-18T13:55:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T23:12:40.000Z (4 months ago)
• Last Synced: 2024-08-04T03:02:19.455Z (3 months ago)
• Language: mcfunction
• Size: 51.8 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mcje-vanilla-tech - 5uso/Mod-Warnings - An weird technique to detect mods. (Basic Techniques)

README

        
# Mod-Warnings

A Minecraft datapack that allows to configure warnings in case certain mods / settings are detected.

Designed for use in maps.

Can detect Spigot, Forge, Fabric API, Optifine, Lunar Client, Essential Mod, having commandblocks off, external datapacks, missing datapacks, and wrong Minecraft versions.

Allows to easily configure custom warnings.

Supports 1.21, confirmed to work all the way back to 1.16.5 as long as you rename the function folder to follow the old structure.

## How to use

Detection runs 1 second after every reload. It can also be run with `function suso.mw:detect/do` (this may cause a datapack reload). The warnings are buffered for each player individually until they move to ensure they are able to see them.

Configuration is done independently for each detectable element. The names used to refer to them are:

- `spigot`: Spigot server

- `forge`: Forge mod loader

- `fabric`: Fabric API (used by most fabric mods)

- `optifine`: Optifine

- `lunar`: Lunar Client

- `essential`: Essential Mod

- `commands`: Commandblocks are disabled

- `misspack`: Found less datapacks than expected

- `extrapack`: Found more datapacks than expected

- `version`: Unintended Minecraft version

- `help`: External commands

In order to turn on detection for a certain element, do `scoreboard players set $d_[name] suso.mw 1`. When this element is detected, score `$[name] suso.mw` will be set to 1 and a warning will be displayed. If you which to turn off the default warning while keeping detection on, you can instead `scoreboard players set $d_[name] suso.mw 2`.

Detecting element `[name]` will also trigger the function tag `#mw/[name]`. These function tags are by default empty and can be found in the `minecraft` namespace of the pack.

### Default warnings

Display a tellraw in chat for every player, briefly informing them about the issue found.

If score `$warn_title suso.mw` is set to 1, a title and playsound will also trigger. By default this is off, but it may be worth enabling so the warnings are harder to miss.

### Datapack count

`misspack` and `extrapack` detect the number of datapacks (both enabled and disabled) that are currently in the world.

To store the intended datapack count, `function suso.mw:count_packs` should be run before packaging the map.

When detecting for either of these two cases, it's recommended to to also enable detection for `spigot`, `forge`, and `fabric`; as they affect datapack count. If you don't want to warn players about these, you should set `$d_spigot suso.mw`, `$d_forge suso.mw`, and `$d_fabric suso.mw` to 2.

### Minecraft version

Minecraft version is detected via the DataVersion tag found in player entities.

To store the intended DataVersion, `function suso.mw:get_version` should be run before packaging the map.

### External commands

External commands are detected by counting the output of `/help`.

To store the intended amount of commands, `function suso.mw:count_help` should be run before packaging the map.

## Crediting

This library is licensed under the [Apache License 2.0](https://github.com/5uso/Mod-Warnings/blob/main/LICENSE). When using it as part of  your own projects, you must:

- Include [crediting for the library](https://github.com/5uso/Mod-Warnings/blob/main/NOTICE) in a way visible to players. This probably fits best into the credits section of your map/datapack in-game, but in case that's impossible it may be done within a text file or documentation distributed with the project.

- Include a copy of the [license](https://github.com/5uso/Mod-Warnings/blob/main/LICENSE).