forked from CatsPnewed/Forkbounce.Archive
Add 'FDP Classic/README.md'
This commit is contained in:
parent
3cceb9a18a
commit
c1e0f8d094
87
FDP Classic/README.md
Normal file
87
FDP Classic/README.md
Normal file
|
@ -0,0 +1,87 @@
|
|||
# FDPClassic v2.1 (modern fdp with older visuals)
|
||||
[![State-of-the-art Shitcode](https://img.shields.io/static/v1?label=State-of-the-art&message=Shitcode&color=7B5804)](https://github.com/trekhleb/state-of-the-art-shitcode)
|
||||
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/fdpclassic/FDPclassic)
|
||||
![GitHub lines of code](https://tokei.rs/b1/github/fdpclassic/FDPclassic)
|
||||
![Minecraft](https://img.shields.io/badge/game-Minecraft-brightgreen)
|
||||
A free mixin-based injection hacked-client for Minecraft using Minecraft Forge based on LiquidBounce.
|
||||
Website: https://fdpinfo.github.io \
|
||||
Latest: [github-actions](https://github.com/fdpclassic/FDPClassic/actions/workflows/build.yml?query=event%3Apush) \
|
||||
Also Latest: https://fdpinfo.github.io/download
|
||||
Discord: https://discord.gg/55x7TaHWXG (ping gatodepan#6386 for support with classic) \
|
||||
Repository: https://github.com/fdpclassic/FDPClassic/
|
||||
|
||||
## Warning from breadcat.
|
||||
fdp classic is use at own risk and is not related with SkidderMc. we will not support you in case somthing goes seriously wrong nor are we responsible.
|
||||
updates may be rare.
|
||||
Fdp classic should not be seen as an alternative to fdp but simply a sister Client sharing most code.
|
||||
|
||||
### versioning
|
||||
fdp classic release version numbers have 2 important parts<br>
|
||||
the first part is the major version number (example 2.3)<br>
|
||||
the second part is the patch letter (example 2.3b)<br>
|
||||
so build 5 of 4.1 would be 4.1e
|
||||
|
||||
## Issues
|
||||
If you notice any bugs or missing features, you can let us know by opening an issue [here](https://github.com/fdpclassic/FDPClassic/issues).
|
||||
|
||||
## License
|
||||
This project is subject to the [GNU General Public License v3.0](LICENSE). This does only apply for source code located directly in this clean repository. During the development and compilation process, additional source code may be used to which we have obtained no rights. Such code is not covered by the GPL license.
|
||||
|
||||
For those who are unfamiliar with the license, here is a summary of its main points. This is by no means legal advise nor legally binding.
|
||||
|
||||
You are allowed to
|
||||
- use
|
||||
- share
|
||||
- modify
|
||||
|
||||
this project entirely or partially for free and even commercially. However, please consider the following:
|
||||
|
||||
- **You must disclose the source code of your modified work and the source code you took from this project. This means you are not allowed to use code from this project (even partially) in a closed-source (or even obfuscated) application.**
|
||||
- **Your modified application must also be licensed under the GPL**
|
||||
|
||||
Do the above and share your source code with everyone; just like we do.
|
||||
|
||||
## Setting up a Workspace
|
||||
FDPClient uses gradle, so make sure that it is installed properly. Instructions can be found on [Gradle's website](https://gradle.org/install/).
|
||||
1. Clone the repository using `git clone --recurse-submodules https://github.com/fdpclassic/FDPClassic.git`.
|
||||
2. CD into the local repository folder.
|
||||
3. Depending on which IDE you are using execute either of the following commands:
|
||||
- For IntelliJ: `gradlew --debug setupDevWorkspace idea genIntellijRuns build`
|
||||
- For Eclipse: `gradlew --debug setupDevWorkspace eclipse build`
|
||||
4. Open the folder as a Gradle project in your IDE.
|
||||
5. Select the Forge run configuration.
|
||||
|
||||
## Additional libraries
|
||||
### Mixins
|
||||
Mixins can be used to modify classes at runtime before they are loaded. FDPClient uses it to inject its code into the Minecraft client. This way, we do not have to ship Mojangs copyrighted code. If you want to learn more about it, check out its [Documentation](https://docs.spongepowered.org/5.1.0/en/plugin/internals/mixins.html).
|
||||
|
||||
## Contributing
|
||||
We are welcome for your contributing, but you have to follow these rules to make us merge your pull request.
|
||||
|
||||
### Language and Code Quality
|
||||
First of all, your code at least can be build, and make bugs as less as you can!
|
||||
And we want to use kotlin features to make coding easier and faster, please use kotlin and make the [Detekt](https://github.com/detekt/detekt) code quality check good and use kotlin features if you can **\***, we never merge shitcode.
|
||||
|
||||
#### Kotlin features
|
||||
Usage of kotlin features and help enhance the code readability
|
||||
kotlin feature examples
|
||||
~~~kotlin
|
||||
Timer().schedule(2000L) {
|
||||
// your code
|
||||
}
|
||||
~~~
|
||||
not using kotlin feature
|
||||
~~~kotlin
|
||||
Timer().schedule(object : TimerTask(){
|
||||
override fun run() {
|
||||
// your code
|
||||
}
|
||||
},2000L)
|
||||
~~~
|
||||
|
||||
### Skid codes
|
||||
Please use original code if you can, and no direct code steals, but we welcome skid using packet logger or anything else like that to skid from a close source and make the cheating community more open!
|
||||
|
||||
### Useless features
|
||||
Useless features means feature only you think its usable ,or feature can be have with config change.
|
||||
Like the "TimerSpeed" option to InfiniteAura, this feature can be added with bind Timer to the key with InfiniteAura, or use macro system in FDP Client.
|
Loading…
Reference in a new issue