Skip to content

Commit 4252d41

Browse files
committed
feat: created README.md and added LICENSE
1 parent c878f55 commit 4252d41

2 files changed

Lines changed: 122 additions & 0 deletions

File tree

LICENSE

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
OS Frozed Club Development License 2.0
2+
Version 2.0, 15 July 2025
3+
https://frozed.club/license/
4+
5+
BY DOWNLOADING, CLONING, FORKING AND/OR USING THIS PROJECT YOU AGREE TO THE LICENSE
6+
7+
1. Definition. This license, referred to as the "OS Frozed Club Development License",
8+
governs the use, redistribution, and modification of the associated software.
9+
By downloading, cloning, forking, and/or using this project, users agree to
10+
adhere to the terms outlined in this license.
11+
12+
2. Redistribution. You may reproduce and distribute copies of this,
13+
use in source and binary forms, with or without modification, are
14+
permitted provided that each of the following conditions are met:
15+
16+
(a) Redistributions of source code must retain the
17+
above copyright notice, this list of conditions and
18+
the following disclaimer.
19+
20+
(b) Redistributions in binary form must reproduce the
21+
above copyright notice, this list of conditions and
22+
the following disclaimer in the documentation and/or
23+
other materials provided with the distribution.
24+
25+
(c) Neither the name of Frozed Club Development contributors nor the names
26+
of the original author of this (Elb1to) may be used to endorse
27+
or promote products derived from this software
28+
without specific prior written permission.
29+
30+
(d) The user, identified as 'iusemeteor', is expressly prohibited
31+
from utilizing, redistributing, promoting, and/or extracting
32+
code from this repository under all circumstances.
33+
34+
(e) An entity wishing to redistribute in binary form or
35+
include this software in their product without
36+
redistribution of this software's source code with the
37+
product must also submit to these conditions where
38+
applicable:
39+
• For every (1) unit distributed, one (1) or more
40+
persons affiliated with the entity must provide
41+
full original crediting to Elb1to and/or Frozed
42+
Club Development.
43+
44+
(f) In order to acquire permission to redistribute this software
45+
you must ask for permission from Elb1to and be granted it
46+
before redistributing any code from this repository.
47+
48+
(g) Under no circumstances may this software or any of its code
49+
be resold or claimed as your own. All credit must be given
50+
to the original author, Elb1to, and Frozed Club Development.
51+
52+
3. Trademarks. This License does not grant permission to use the trade
53+
names, trademarks, service marks, or product names of the Licensor,
54+
except as required for reasonable and customary use in describing the
55+
origin of the Work and reproducing the content of the LICENSE file.
56+
57+
Copyright © 2025 Elb1to
58+
Licensed under the OS Frozed Club Development License, Version 2.0 (the "FCDL-2.0").
59+
60+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
61+
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
62+
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
63+
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
64+
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
65+
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
66+
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
67+
CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
68+
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
69+
DAMAGE. FROZED CLUB DEVELOPMENT ACCEPTS NO LIABILITY FOR ANY EXPENSES SUSTAINED IN
70+
THE ACT OF FULFILLING ANY OF THE ABOVE TERMS AND CONDITIONS, ACCIDENTAL OR OTHERWISE.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# FrozedHider
2+
3+
A Minecraft plugin that uses the WorldGuard API to hide players within designated regions. When a player enters a
4+
specified WorldGuard region, they become invisible to other players, and upon exiting, they are revealed again. This is
5+
all done with packets, so players are not removed from the Tablist.
6+
7+
## Features
8+
9+
- Lightweight and easy to use.
10+
- Hide players in configurable WorldGuard regions using the `hide-player` flag.
11+
12+
## Dependencies
13+
14+
- [PaperSpigot 1.21.4](https://fill-data.papermc.io/v1/objects/5ee4f542f628a14c644410b08c94ea42e772ef4d29fe92973636b6813d4eaffc/paper-1.21.4-232.jar)
15+
- [WorldGuard v7.0.13](https://dev.bukkit.org/projects/worldguard/files/6201343/download)
16+
17+
## Building
18+
19+
To build the project, you will need:
20+
21+
- Java 21 or higher
22+
- Maven
23+
24+
Clone the repository and run the following command:
25+
26+
```bash
27+
mvn clean package
28+
```
29+
30+
## Installation
31+
32+
1. Download the latest release from the [releases page](https://github.com/FrozedClub/frozedhider/releases).
33+
2. Place the `frozedhider-1.0.0.jar` file in your server's `plugins` folder.
34+
3. Restart or reload your server.
35+
36+
## Configuration
37+
38+
The configuration is located in `plugins/FrozedHider/config.yml`.
39+
40+
```yaml
41+
# This will show a message on chat when a player enters or exits a region.
42+
debug: false
43+
```
44+
45+
## Author
46+
47+
This plugin is developed and maintained by [Elb1to](https://elb1to.me).
48+
49+
## License
50+
51+
This project is licensed under the FCDL-2.0 License - see the [LICENSE](LICENSE) file for details.
52+

0 commit comments

Comments
 (0)