Skip to content

Commit 2c7c481

Browse files
aymnmsaymnms
committed
feat: add README
1 parent c427f7f commit 2c7c481

File tree

2 files changed

+140
-0
lines changed

2 files changed

+140
-0
lines changed

‎LICENSE‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2025 aymnms
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<a id="readme-top"></a>
2+
3+
<!-- PROJECT SHIELDS -->
4+
[![Contributors][contributors-shield]][contributors-url]
5+
[![Forks][forks-shield]][forks-url]
6+
[![Stargazers][stars-shield]][stars-url]
7+
[![Issues][issues-shield]][issues-url]
8+
[![License][license-shield]][license-url]
9+
10+
<br />
11+
<div align="center">
12+
<h3 align="center">SkipNight</h3>
13+
<p align="center">
14+
A Minecraft plugin that lets you skip the night even if not everyone is sleeping.
15+
<br />
16+
<a href="https://github.com/aymnms/skip-night"><strong>View the code »</strong></a>
17+
<br />
18+
<br />
19+
<a href="https://github.com/aymnms/skip-night/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
20+
·
21+
<a href="https://github.com/aymnms/skip-night/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
22+
</p>
23+
</div>
24+
25+
---
26+
27+
## 📜 About The Project
28+
29+
`SkipNight` is a lightweight plugin that allows skipping the night in Minecraft **without requiring all players to sleep**.
30+
It works on **Minecraft 1.7 to 1.16**, filling the gap before the native `playersSleepingPercentage` gamerule introduced in 1.17.
31+
32+
- Tracks players entering and leaving beds
33+
- Skips the night when at least half of the players are sleeping
34+
- Fully compatible with Spigot and Paper
35+
- Automatically disables itself on Minecraft 1.17+
36+
37+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
38+
39+
---
40+
41+
## 🔧 Built With
42+
43+
* Java 8
44+
* Spigot API 1.8.8 (compatible 1.7.10–1.16.5)
45+
46+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
47+
48+
---
49+
50+
## 🚀 Getting Started
51+
52+
### Prerequisites
53+
54+
- Java 8 (JDK)
55+
- Spigot/Paper server between version 1.7 and 1.16
56+
57+
### Installation
58+
59+
1. Download the latest `.jar` from [Releases](https://github.com/aymnms/skip-night/releases)
60+
2. Place it in the `plugins/` folder of your server
61+
3. Start the server
62+
4. You're done!
63+
64+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
65+
66+
---
67+
68+
## 🕹️ Usage
69+
70+
Whenever a player sleeps:
71+
- A message appears showing how many are sleeping
72+
- If half or more players are in bed, the night is skipped
73+
74+
If someone leaves bed or disconnects, the plugin automatically recalculates everything.
75+
76+
You’ll see messages like:
77+
```
78+
[SkipNight] aymnms would like to skip the night [1/2]
79+
[SkipNight] The sun rises.
80+
```
81+
82+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
83+
84+
---
85+
86+
## 🗺 Roadmap
87+
88+
- [x] Version compatibility from 1.7 to 1.16
89+
- [ ] Configurable sleep percentage
90+
- [ ] Custom messages via `config.yml`
91+
- [ ] Localization support (FR/EN)
92+
93+
See the [open issues](https://github.com/aymnms/skip-night/issues) for more ideas.
94+
95+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
96+
97+
---
98+
99+
## 🤝 Contributing
100+
101+
1. Fork the project
102+
2. Create a feature branch (`git checkout -b feature/MyFeature`)
103+
3. Commit your changes (`git commit -m 'Add MyFeature'`)
104+
4. Push to your branch (`git push origin feature/MyFeature`)
105+
5. Open a Pull Request
106+
107+
<a href="https://github.com/aymnms/skip-night/graphs/contributors">
108+
<img src="https://contrib.rocks/image?repo=aymnms/skip-night" />
109+
</a>
110+
111+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
112+
113+
---
114+
115+
## 📝 License
116+
117+
Distributed under the MIT License. See `LICENSE` for more information.
118+
119+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
120+
121+
---
122+
123+
<!-- MARKDOWN LINKS & IMAGES -->
124+
[contributors-shield]: https://img.shields.io/github/contributors/aymnms/skip-night.svg?style=for-the-badge
125+
[contributors-url]: https://github.com/aymnms/skip-night/graphs/contributors
126+
[forks-shield]: https://img.shields.io/github/forks/aymnms/skip-night.svg?style=for-the-badge
127+
[forks-url]: https://github.com/aymnms/skip-night/network/members
128+
[stars-shield]: https://img.shields.io/github/stars/aymnms/skip-night.svg?style=for-the-badge
129+
[stars-url]: https://github.com/aymnms/skip-night/stargazers
130+
[issues-shield]: https://img.shields.io/github/issues/aymnms/skip-night.svg?style=for-the-badge
131+
[issues-url]: https://github.com/aymnms/skip-night/issues
132+
[license-shield]: https://img.shields.io/github/license/aymnms/skip-night.svg?style=for-the-badge
133+
[license-url]: https://github.com/aymnms/skip-night/blob/master/LICENSE

0 commit comments

Comments
 (0)