Skip to content

ProvidenceMod/ProvidenceMod

Repository files navigation

Providence

Providence is a remorseful story about an unforgiving world. A world in which you must fight and emerge victorious against all odds. An immersive and original tale permeates the world around you, with thematic locations spread throughout Terraria, the Universe, and its realms. Explore the mystical atmosphere of our world, introducing an elemental system, new mechanics, new progression, new soundtracks, and our handcrafted visuals. Explore our subworlds; completely separate realms from the typical Terraria surroundings, extending the number of unique areas to discover. Experience entire realms with hidden treasures and evils, awaiting your discovery. Fight off new and unique bosses and experience the challenge that is our bullet hell design, optionally made even more challenging by our difficulty modifiers.

Warriors, wielders of the Primordial Flame, infused with its wrath and resilience.

Rangers, wielders of the Cosmos, who use the stars to imbue their attacks with untold power.

Mages, wielders of the Prismatic Flare, masters of all six elemental forces which they use to obliterate their foes.

Summoners, wielders of Astrum, who infuse their servants with the power of the cosmos and call upon the aid of Astrid.

Clerics, wielders of Parity Reality, who bend the universe to their will to alternate between heal and harm.

Wraiths, wielders of Quantum Flux, who bend space-time to inflict serious harm upon their foes and effortlessly evade attacks.

The world of Providence anticipates your attempts at survival, and despite how close you may come, there will always be another more unrelenting battle to fight.

It is a cruel world with an unforgiving story wreathed in flame and looming shadow. Your invigorating journey awaits you. The saddening story of the world has yet to reveal itself. Such a cruel fate for those who would stand in the way of change. Are you truly prepared for what lies ahead? The faint of heart should turn away, for those who lack courage will find no respite here. You will endure an unforgiving challenge.

You will suffer. You will die.

Providence Mod

This is the source code for the ProvidenceMod project; A mod for Terraria via tModLoader.

A large-scale project planned to be an overhaul mod for Terraria. We have several mechanics planned for implementation, as well two new classes; Cleric, and Wraith, and we have big plans for future additions, the scale of which you've likely seen in other big Terraria mods. This is a passion project, and so far our very small community of people has been helping us better our mod bit by bit with new content suggestions and other helpful contributions. While we might just be starting, it is said that there is a lot of promise and potential in our mod so far, and we are a dedicated and involved team of Devs working on making this dream a reality.

For many of us, myself included, this is our first project in CSharp. We've been learning the language over time and have grown very fond of it. We plan on seeing this project through, if not out of dedication, simply out of passion. We hope to influence others to learn with us as we take this project and its community to the next level.

Added content:

  • One boss
  • One new ore
  • One new set of items
  • One subworld (Incomplete)
  • A new class: Cleric
  • A new class: Wraith

Planned Content:

  • Elemental System
  • New Subworlds
  • New Biomes
  • New Ores
  • New Weapons
  • Lots and lots of bosses
  • Much Post-Moonlord Content
  • World Fluff ( To make it feel more alive )
  • Quests for existing NPCs
  • Elaborated NPC lore
  • A new class: Wraith
  • Class Gimmicks
  • New Achievements
  • Interactive and Passive Cutscenes
  • Interactive and Passive Lore Elaboration
  • And much more

Discord Server:

Discord Banner 3

FAQ

Why is this mod Open Source?

One of our biggest hurdles when beginning to mod was finding accurate resources outside of the tModLoader GitHub, the tModLoader Discord, or Example Mod. Many forums or other resources were simply outdated or inaccurate. This inspired us to make our mod Open Source, not only because we want to act as a form of Example Mod in the sense that it is an example for people to follow, but also because this will be an overhaul mod, so there are plenty of examples to follow. We are also completely open to helping new modders learn CSharp and the tModLoader API.

When am I allowed to adapt code from this mod?

It should be mentioned that although this mod is open source, plagiarism is not okay. As cited in the tModLoader Wiki page about Open Source Mods:

Remember, you can't just copy code from these mods unless the license they are under specifically allows it. If there is no license, the owner reserves all ownership and copyright of the code, so you need to contact the owner and ask permission to utilize certain parts. Don't worry, most will be happy to allow you to use portions of their code, but you still need to ask.

While we might allow most utilities to be copied, it is still important to ask us which code is safe to copy and which code is not. Remember, this is a mod that you use to LEARN, not copy and paste. If you learn the code you will never need to copy and paste from outside sources and we are more than willing to help you understand the code. There are bits of code, however, that we do list as "Free To Use", which means we are permitting you to use that code in your projects. That does not, however, pass off ownership of the code to you. So if someone asks about how it works or if you wrote it yourself, link them to this repository, because the chances are that they will benefit from seeing the original if they are asking those questions. You are doing yourself, them, and us a favor!

Where are the best places to contact the Developers?

You may contact us through email or Github Issues. However, the best place to contact us is through our Discord server.

How can I contribute?

Any contributions are welcome. If you have ideas, the best place to send them to us is in our Discord server. Sprites are always welcome, though it should be noted that you may benefit from contacting our team's spriters to work with them. If you want to suggest music, we suggest contacting our team's music artists to work with them. The best place to suggest code is by using GitHub issues, however, you should read our Wiki page on code formatting before contributing code. Contributing lore is a bit trickier than the other three. This is where you might need to talk with our team since writing lore needs to be concise and sound with the rest of existing lore.

Table of Contents

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Installation

To install our mod, simply follow these steps:

  1. CLone the repo into your Mod Sources folder using your GitHub medium of choice. We like to use GitHub Desktop.
  2. You can now build the mod from the Mod Sources menu in tModLoader. If you have not properly set up your coding environment and do now have Mod SOurces, please visit this comprehensive guide on the tModLoadker Wiki.

Pull Request Process

  • Please follow the pull request template.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Developers

Contributors

Credits

Thank you to the Dev team for toughing out the beginning and helping make this distant hope into a reachable dream. Thank you to all of our supporters who helped make this reachable dream into reality. Thank you to the tModLoader team and everyone on the tModLoader server for helping us out when we were stumped. Thank you to the open-source mod developers who were our torchlight when we were lost. And most of all, thank you to Re-Logic for creating such a wonderful game.

-SnowyStarfall and the ProvidenceMod Dev Team

Special Thanks

Special thanks to Lance, Zackfox, Faelink Angel, Lythane, Keithixix197, Makeeto, Daken000, GildedLily, AmyTheRogue, FloofLeo, and GenesisFuz for all of the ideas, suggestions, contributions, and support.

Contributor Covenant Code of Conduct

Please follow this Code of Conduct when undertaking any interaction in our GitHub repository, or any of its children.

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity, and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at snowystarfall.art@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality concerning the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq