mirror of
https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2.git
synced 2026-10-11 01:48:14 +08:00
docs: add readme
This commit is contained in:
1 parent
4d3d467edb
commit
e4cdb04a49
1 file changed
+73
@@ -0,0 +1,73 @@
|
||||
|
||||
<br/>
|
||||
<div align="center">
|
||||
<a href="https://github.com/ShaanCoding/ReadME-Generator">
|
||||
<img src="https://git.funtimes909.xyz/repo-avatars/248ef58dc8dc0ffa0a1cd47485a11703b49348540f2877b747c1846b843552b0" alt="Logo" width="80" height="80">
|
||||
</a>
|
||||
<h3 align="center">ServerSeekerV2</h3>
|
||||
<p align="center">
|
||||
Blazingly fast Minecraft server scanner written in Rust 🦀 🚀
|
||||
<br/>
|
||||
<br/>
|
||||
<a href="https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2/wiki"><strong>Explore the docs »</strong></a>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<a href="https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2/issues/new">Report Bug .</a>
|
||||
<a href="https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2/issues/new">Request Feature</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## About The Project
|
||||
|
||||

|
||||
|
||||
ServerSeekerV2 is a complete rewrite of the original ServerSeeker but faster and better with more features. ServerSeekerV2 is written in Rust allowing it to be blazingly fast and memory safe. 🦀 🚀
|
||||
### Built With
|
||||
|
||||
- [Rust](https://www.rust-lang.org/)
|
||||
- [tokio](https://crates.io/crates/tokio)
|
||||
- [sqlx](https://crates.io/crates/sqlx)
|
||||
- [serde](https://crates.io/crates/serde)
|
||||
### Installation
|
||||
|
||||
Download the executable from the Releases tab. (Soon)
|
||||
## Usage
|
||||
|
||||
1. Copy the [example config file](https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2/src/branch/main/config-example.toml) and fill out the information
|
||||
2. Set the right permissions
|
||||
```sh
|
||||
chmod +x ./ServerSeekerV2-Rust
|
||||
```
|
||||
3. Run the scanner
|
||||
```sh
|
||||
./ServerSeekerV2-Rust
|
||||
```
|
||||
4. Enjoy
|
||||
|
||||
WARNING: Do not run this at home, it will melt your home network and your ISP will be angry at you.
|
||||
## Roadmap
|
||||
|
||||
Soon.
|
||||
|
||||
See the [open issues](https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2/issues) for a full list of proposed features (and known issues).
|
||||
## Contributing
|
||||
|
||||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||
|
||||
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
|
||||
Don't forget to give the project a star! Thanks again!
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
## License
|
||||
|
||||
Distributed under the GPLv3 License. See [GPLv3 License](https://opensource.org/license/gpl-3-0) for more information.
|
||||
## Contact
|
||||
|
||||
Your Name - [@me:funtimes909.xyz](https://matrix.to/#/@me:funtimes909.xyz)
|
||||
|
||||
Project Link: [Funtimes909 Forgejo](https://git.funtimes909.xyz/ServerSeekerV2/ServerSeekerV2)
|
||||
Reference in new issue
Block a user