Skip to content

Commit

Permalink
New Readme (#319)
Browse files Browse the repository at this point in the history
  • Loading branch information
Desoroxxx committed Dec 18, 2023
1 parent f79d629 commit 2b3c7aa
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 56 deletions.
119 changes: 63 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,86 +1,93 @@
<h1 align="center">Modern Warfare Cubed</h1>
[![Curse Forge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/mc-mods/alfheim-lighting-engine)
[![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/alfheim-lighting-engine)

<h5 align="center">A well optimized, open source Modern Warfare fork, made in light of Vic's Modern Warfare!</h5>
[![Patreon](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/patreon-plural_vector.svg)](https://patreon.com/ModernWarfareCubed)
[![Discord](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/k5WPk93K7b)

<p align="center">
<a href="https://modrinth.com/mod/modern-warfare-cubed">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg">
</a>
# Modern Warfare Cubed

<a href="https://www.curseforge.com/minecraft/mc-mods/modern-warfare-cubed">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg">
</a>

<a href="https://patreon.com/ModernWarfareCubed">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/patreon-plural_vector.svg"/>
</a>
**Modern Warfare Cubed** is a well optimized, open source Modern Warfare fork, made in light of the now discontinued, Vic's Modern Warfare!

<a href="https://discord.gg/k5WPk93K7b">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg">
</a>
</p>

<p align="center">
<a href="https://adoptium.net/temurin/releases/?version=8">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/java8_vector.svg"/>
</a>
![Features Showcase](https://github.com/Cubed-Development/Modern-Warfare-Cubed/tree/main/assets/showcase/Features%20Showcase.gif)

<a href="https://gradle.org/">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/gradle_vector.svg"/>
</a>
This mod introduces a plethora of new features to Minecraft, including an extensive arsenal of modern weaponry, new explosives, vehicles, and more.

<a href="http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.12.2.html">
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/forge_vector.svg"/>
</a>
</p>
It introduces a wide range of modern weapons to Minecraft, including assault rifles, sniper rifles, shotguns, pistols, and more. These weapons are modeled after real-life firearms and come complete with authentic sound effects and animations.

<br>
### High-Quality and realistic style guns!

<h2 align="center">How do I contribute?</h2>
![Weapon Showcase](https://github.com/Cubed-Development/Modern-Warfare-Cubed/tree/main/assets/showcase/Weapon%20Showcase.gif)

<br>
## Gun Customization & Statistics!

Anyone and everyone is welcome to contribute and help out with the project!
Our weaponry is heavily customizable with a highly advanced attachment system made up of 3 main parts; **Customization**, **Modification** and **Attachments**.

To contribute, please read the [contributing guide](https://github.com/Paneedah/Modern-Warfare-Cubed/blob/master/CONTRIBUTING.md).
Each weapon has its own unique attributes, such as rate of fire, accuracy, and damage. Some weapons have specialized attachments that can be added, like scopes, suppressors, and more, to further enhance their performance.

Here's a sneak-peak into what it looks like in-game!

<h4>Want to join the Development Team?</h4>
![Modification Showcase](https://github.com/Cubed-Development/Modern-Warfare-Cubed/tree/main/assets/showcase/Modification%20Showcase.gif)

Our developers are hand-picked by current members of the Development Team. The main way to get noticed is by either contacting a member of the team (only if you've previously worked on any other projects or are *very* familiar with the Forge API), or by submitting Pull Requests which we try to Merge quite actively.
## Tablets and Cameras!

<br>
A feature that allows you to put cameras on entities and watch what they're doing! But be careful! The cameras have a limited range before they lose functionality and start to glitch out. Throw cameras at mobs, or even other players!

<h2 align="center">Meet our Team & Credits</h2>
Simply press your Left and Right arrow keys to navigate between cameras!

<br>
![Camera Showcase](https://github.com/Cubed-Development/Modern-Warfare-Cubed/tree/main/assets/showcase/Camera%20Showcase.gif)

Massive shoutout to the author of [Vic's Modern Warfare Mod](https://github.com/vic4games/modern-warfare): [Vic4Games](https://github.com/vic4games) and the rest of his team for the original mod, and some of the textures / models / other assets that have been utilized from their mod.
## Support Us!

Are you enjoying our mod? Consider supporting!
The **Cubed Development Team** is working hard to keep this project going and maintaining as an open-source project that is free for anyone to use! You can support us on [Patreon](https://patreon.com/ModernWarfareCubed)!

All monetary contributions made via Patreon are being put right back into the development of the mod.

[![Patreon](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/patreon-plural_vector.svg)](https://patreon.com/ModernWarfareCubed)
[![Discord](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/k5WPk93K7b)

### What can I get from supporting?

You can find out about all the juicy perks that you unlock on our [Discord](https://discord.gg/k5WPk93K7b) (and on our Patreon home-page)! But honestly, what more do you need other than our love?

[![BisectHostingPromoBanner](https://www.bisecthosting.com/partners/custom-banners/98433ee8-ec42-4242-907c-f2c949bb0e8b.png)](https://bisecthosting.com/mwc?r=MWC+GitHub)

## Need to get in touch?

Our primary way of communicating with the community is through our [Discord Server](https://discord.gg/k5WPk93K7b). Join our great community today!

Another massive thank you to all of the contributors, and members of the development team. We wouldn't be where we are now without the support from you all!
Feel free to send an email to paneedah@panada.cc if you have any concerns, are looking to partner, or need to contact the ownership of Modern Warfare Cubed personally. Please note that this inbox will not reply to any queries or help about the mod itself, please use the discord server for that instead.

<br>
## Contributing

**Official Development Team**
Anyone and everyone is welcome to contribute and help out with the project!

To contribute, please read the [contributing guide](https://github.com/Paneedah/Modern-Warfare-Cubed/blob/master/CONTRIBUTING.md).

### Want to join the Development Team?

Our developers are hand-picked by current members of the Development Team.
The main way to get noticed is by either contacting a member of the team (only if you've previously worked on any other projects), or by submitting pull requests.

## Meet our Team & Credits

Massive shoutout to the author of [Vic's Modern Warfare Mod](https://github.com/vic4games/modern-warfare): [Vic4Games](https://github.com/vic4games) and the rest of his team for the original mod, and some of the textures / models / other assets that have been utilized from their mod.

Another massive thank you to all the contributors and members of the development team.
We wouldn't be where we are now without the support from you all!

### Official Development Team
- [Paneedah](https://github.com/Paneedah) - Lead Developer
- [BurnhamR](https://github.com/BurnhamR) - Lead Developer
- [Desoroxxx](https://github.com/JustDesoroxxx) - Head Developer
- [SticksDev](https://github.com/SticksDeveloper) - Developer
- [Koud-Wind](https://github.com/Koud-Wind) - Developer
- [Azurae](https://github.com/azuraerae) - Developer

<br>

**Official Design Team**
- SneakyDanny#1024 - Lead Designer
- DeletedUser#9471 - Full-Stack Designer
- Vic4Games#1615 - Full-Stack Designer
- ‡Arathorne84‡🍉#6930 - Model Designer
- StinkyCake#5932 - Model / Texture Designer
- YamaEikiShiki#0828 - Model Designer
<br>
### Official Design Team
- [Braiam23](https://github.com/Braiam23) - Lead Designer

**Our Contributors**
### Our Contributors

<a href="https://github.com/Paneedah/Modern-Warfare-Cubed/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Paneedah/Modern-Warfare-Cubed"/>
</a>
[![Contributors](https://contrib.rocks/image?repo=Paneedah/Modern-Warfare-Cubed)](https://github.com/Paneedah/Modern-Warfare-Cubed/graphs/contributors)
Binary file added assets/showcase/Camera Showcase.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/showcase/Features Showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/showcase/Modification Showcase.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/showcase/Weapon Showcase.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2b3c7aa

Please sign in to comment.