Giter Club home page Giter Club logo

am2r-community-updates's Introduction

AM2R-Community-Updates

What is this?

The source code for the AM2R Community Updates 1.5.x branch, free of copyrighted assets and trademarks. If you have not played the AM2R Community Updates before, this will be of no use to you!

This source code is based on AM2Rrc by YellowAfterlife. It could be considered a fork.

If you are looking for a playable build of the game, please download the AM2RLauncher to install the latest update.

Copyright clarifications

This source code does not contain any copyrighted assets or trademarks - in fact, it does not contain any assets at all, just like the AM2Rrc repository.

Assets must be extracted from your copy of the AM2R Community Updates using GMXDataSync in order to compile this project properly.

Furthermore, there are two paid shader assets included in the Community Updates: Pixelated Pope's Retro Palette Swapper and PixHammer's GameBoy Shader. We do not curently have permission to distribute either of these assets, so they are excluded from this repository. You will need to replace them with default shader code in order for the project to compile.

Finally, we have excluded the datafiles and changelog from this repository to further enforce the removal of trademarks.

License

Please read our license before distributing, modifying, contributing to, or otherwise interacting with this project.

Contributing

Please read our Contribution Guidelines before opening any issues or creating pull requests.

Additionally, it would be most helpful if you joined the Official AM2R Discord Server if you plan on contributing to the project.

Known issues

The vast majority of this source code is undocumented, as it is based on a bytecode reconstruction.

The default language files will display three empty fields when loaded due to recent name changes. This will be a non-issue once 1.5.3 releases.

Reordering assets created before the Community Updates began can have consequences throughout the entire project because of magic numbers: references to assets by numeric ID instead of name. Changing asset order will cause magic number references throughout the source code to begin referencing incorrect assets. Because of this, pull requests that attempt to reorganize assets will be denied.

Much of this code is messy, uses unusual solutions, and does not hold to our established formatting style - this is a result of AM2R's reconstruction and nature as a learning project passed down to multiple lead developers.

Requirements

GameMaker: Studio 1.4.1763 - the IDE for editing and compiling this project.

GMXDataSync - a utility created by YellowAfterlife to populate project files with matching game assets.

A copy of the latest release build of the AM2R Community Updates, which can be installed via the AM2RLauncher.

Installation

This repository, being based on YellowAfterlife's source reconstruction, is installed in a very similar fashion. Please refer to his installation instructions here, but replace 1.1's data.win with the latest Community Update AM2R.exe.

Afterwards, replace the two blank shader assets with default GM:S shader skeletons or your own copy of each shader, as well as the accompanying script files for the Retro Palette Swapper: pal_swap_init_system and pal_swap_set.

Finally, you will need to install modifiers.ini as well as the lang and mods folders as datafiles within the GM:S project. The default ones do not contain the actual assets and are merely references. These can be copied over from your AM2R_15_2 folder.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.