addsynth/overpowered-technology-forge-1.16

Overpowered Technology Minecraft mod for Minecraft 1.16.x

Introduction

Welcome to the source code repository for the Overpowered mod for Minecraft, by ADDSynth. The source code is licensed under GNU GPL v3.0 or Later, with The Commons Clause.

Last Updated: May 18, 2021

The source code, including this file, will continually be improved upon as time goes on.

Owner
: ADDSynth

• Links
• About the Project
• How to Build
• Format Rules
• License

Links

You can Download Overpowered on CurseForge.
Download on CurseForge

For information about the mod itself, you can view the
online reference for Overpowered.

We are currently searching for a new platform to host the online reference allowing users to edit pages and allowing multiple languages.

If you wish to support the development of Overpowered, consider donating. To donate with PayPal, click the following link. A PayPal account is required. This is temporary as we're currently in the process of switching to a new method of donating.
https://paypal.me/ADDSynth

Join our Discord server:
https://discord.gg/U6nmwrZ

Follow ADDSynth on Twitter. (But I never post there)
https://twitter.com/AddSynth

Any videos about Overpowered I'll post to my channel on YouTube:
ADDSynth on YouTube

Business email: (but please contact via one of the above methods)
[email protected]

About the Project

I'm still not all that familiar with how Github works. But I'm pretty sure you can clone the repository and make pull requests if you think there's something you can improve about the mod. Please, please, please, please make your pull request for the LATEST Minecraft version. I have ways of copying your code down to the other Minecraft versions.

For feature requests click on the Issues tab and make an Issue about it.

If you are intent on becoming an active developer for this or other Github projects, then we recommend you download and use the Github Desktop program. You can use it to easily make commits, pull requests, or branches.

I'm slowly starting to understand the importance of having more than one branch, but until then, I only work on the Master branch, and I often overwrite the commit history to fix something in the last commit I submitted, so I recommend you try to stay a few commits behind if possible.

We use several additional Task Tags rather than the standard TODO. Please configure your IDE to recognize these Task Tags.

Task Tag	Priority	Description
FIX	High	When I know for sure something causes a crash that needs fixing.
PRIORITY	High	Something that needs to be worked on next or soon, before the next release.
FUTURE	Normal	Describes features I plan to add in the future, but can't right now.
OPTIMIZE	Normal	Code that can be upgraded or improved.
REMOVE	Normal	Code that is scheduled to be removed at a later time. Must specify when to remove.
TEST	Normal	Further testing is required to see if there's a better way to do something.
DELETE	Low	Commented code that can be deleted when I'm sure I won't miss it.
FEATURE	Low	Describes a feature that would be nice to have, but ultimately not needed at the moment.
MAYBE	Low	Suggests an alternative.
NOTE	Low	Leaves a note about the code, so I can find it later.
REPLICA	Low	Code that is an exact duplicate of someone else's code, because I need a custom version. Must check for any differences each time the external code is updated.
UNUSED	Low	Code that was added, but doesn't do anything. Safe to leave as is.

How to Build

Looks like you just need to download a copy of this repository and extract the zip file to your preferred location.

Use a Console, Terminal, or Command Prompt to navigate to the folder you extracted.

To Build:
Just type 'gradlew build' and the output .jar file will be in build/libs.

To setup Development workspace:
Type the command 'gradlew eclipse', or replace eclipse with your preferred IDE. You can type 'gradlew tasks --all' to get a list of all Gradle tasks.

Source Code Formatting

We prefer the source code be formatted in a specific way, but we're not strict about it. We won't decline or turn away pull requests if they do not follow these format rules. I'll probably just reformat it myself later in the future anyway.

1. We use spaces, not tabs. An indent is 2 spaces.

2. All blocks statements must have brackets, even one line 'if' statements. We often need to move lines of code from place to place, and it is very convenient to go to the start of the line and hold SHIFT and press DOWN to select the whole line, then use the common keyboard cut and paste commands.

3. Keep code safe. Most variable declarations are explicitly initalized to some value. I understand that putting everything in a 'try/catch' block is not always convenient, but at the very least you should report errors to the log if an error does occur. And above all, THE GAME SHOULD NEVER CRASH.

   Use the '@Override' and '@Nonnull' and '@Nullable' attributes if the overridden method also uses them.

4. Keep code simple and easy to understand.

   1. Initalize variables one line at a time. We prefer this partly because of the same reason above, where sometimes the variable needs to be changed or moved. For instance:

   'int x = 0;
   int y = 0;
   int width = 0;
   int height = 0;
   int space = 0;'

   NOT

   'int x, y, width, height, space = 0;'

5. If you're going to use a variable inside a loop, initalize the variable outside the loop, so that you can reuse it. Example:

'int i;  
 int id; // gets assigned before use, so it's okay to leave it uninitialized  
 for(i = 0; i < array.length; i++){  
   id = getID(array\[i\]);  
 }'

NOT

'for(int i = 0; i < array.length; i++){  
   int id = getID(array\[i\]);  
 }'

3. Use long variable names! I actually consider this to be very important. Source code is meant to be read by humans, so it should be easy to understand. Compilers don't care how long your variable names are so make sure it is descriptive enough.

   'int x_position;
   int number_of_lasers;
   String message;'

NOT

'int x_pos;  
 int num_lasers;  
 String msg;'

4. Function arguments should have a space in between them.

5. Although, in most languages, declaring a field without an access modifier is implicitly defined as being private to that class, we still prefer you type out the private keyword.

6. Using conditional statements is fine as long as they're simple enough. So for instance 'return tile != null ? tile.getSomething() : null' is perfectly fine. But if your conditional statement gets any more complicated than that, or consists of multiple embedded conditional statements, it may be better to use embedded if statements instead, or even a dedicated function.

7. Also, I often like to space out lines of code so that they line up with each other. This is not as important as some of the other rules. But in regards to this, I've noticed that the lists often become misaligned because I used a Refactor command to change the name of something which I then discover later messes up the alignment of a list somewhere.

8. Variables should be in lowercase underscore style, but when it comes to methods I'm guilty of using both camelCase and lowercase underscore, so whatever.

9. Yes, I frequently add the keyword 'final' to method declarations and arguments. This was back when I was learning Java, and they said adding 'final' would be a minor optimization because it signals to the compiler that the method/argument never changes, so it doesn't need to check that itself. In practice this is extremely insignificant. You do not need to follow my lead in this case. It's also been unhelpful once or twice because I had to remove the 'final' keyword so I could override a method.

10. Never had to use Access Transformers to do Java bytecode manipulation. But if all it does is allow access to vanilla fields and methods that are private, I prefer to use Reflection for that. But in order to use Reflection you need to know the SRG name of the field or method you want, because fields and method names are obfuscated outside a dev environment and are translated to be easier to read inside a dev environment.

License

This source code is licensed under the GNU General Public License v3.0 (or later) with The Commons Clause.
GNU General Public License v3.0
The Commons Clause

If you're just wondering if you can include this mod in modpacks, the answer is YES, as long as you credit ADDSynth as the author and provide a link back to the CurseForge project page.

If you're in a hurry and don't want to read the full license(s), here's a quick rundown of what you can and can't do:

1. You may copy any part of the source code to use in your own projects, as long as it's a small part or sample. Giving credit is not required but appreciated. My code then becomes a part of your project and you are free to do with as you wish.
2. You are NOT allowed to copy large or significant portions of the source code to use in your own projects, or claim it as your own code. If you are unsure what constitutes 'a large portion' then ask me first.
3. You are NOT allowed to sell any portion of the source code, or the entire source code, or its compiled form. You are not allowed to make any profit from my work.
4. You are allowed to clone the repository and make derivatives of the original source code. However, you must explain that this is a modified version of the original. You must credit the original source repository. You are not allowed to make any profit from derivitive works. And any derivatives must be licensed under a similar or more restrictive license.
5. If you just want to make one change or fix, or otherwise improve upon the source code, it might be better to make a pull request or feature request, so that it gets included into the main project. Anyone is allowed to make pull requests and/or make changes to the source code, subject to verification by the owner (ADDSynth). Once approved your pull request becomes a part of the commit history, which states WHO did WHAT, and WHEN. Your source code then becomes a part of this project, and owned by ADDSynth. Anyone who makes significant contributions to this project will be listed in the Credits section above.