aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRitabrata Das <[email protected]>2025-01-29 21:44:24 +0530
committerRitabrata Das <[email protected]>2025-01-29 21:44:24 +0530
commit22ff24cbbfec55114f963c50380a9170940c4502 (patch)
treec642d5025c9858580fe175451248fdd372debedb
parentf68b5a0c3d8509c8780576155fa85a6f0d573042 (diff)
Update README and config
-rw-r--r--README.md16
-rw-r--r--config.py3
2 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index 55c76ff..3bd3c45 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@
### Perfect and Elegant Anti Cheat for your YSFlight server
---
+Well it started as an anti cheat... and now aims to add more features to make YSFlight more realstic server side
+for vanilla clients.
## **Features**
- Intercepts and parses network packets to monitor gameplay.
@@ -72,14 +74,12 @@ This project is licensed under the GNU General Public License v3.0. See the [LIC
---
-## **Contributing**
-Contributions are welcome! To contribute:
-1. Fork the repository.
-2. Create a feature branch (`git checkout -b feature-name`).
-3. Commit your changes (`git commit -m 'Add some feature'`).
-4. Push to the branch (`git push origin feature-name`).
-5. Open a pull request.
-
+## **Reporting Issues**
+1. Use Github issues tab to open an issue.
+2. Please provide detailed information about the issue you are facing.
+3. Give us all the log from console, it would be better if logging level was set to ``DEBUG``
+4. Please also give us the replay .yfs file while reporting issue
+5. If you have a feature request, please open an issue with the label `feature-request`.
---
## **Acknowledgments**
diff --git a/config.py b/config.py
index 78e7a4c..ab3b14c 100644
--- a/config.py
+++ b/config.py
@@ -15,6 +15,7 @@ PROXY_PORT = 9000
# Native YSFlight Server
# Please select the YSFlight server version for the
# local ysflight server
+# Tested only with 20150425 version
YSF_VERSION = 20150425
@@ -25,6 +26,8 @@ YSF_VERSION = 20150425
VIA_VERSION = True
# G Limit (abs(g) >= limit) and the player gets killed
+# If you wish to turn off G Limiter, consider using some
+# aribitary value like 100
G_LIM = 4
# Will appear as message + player name