diong / PokemonUnity

A LEGACY Unity project to help build Pokémon-esque RPG games.

<<<<<<< HEAD

Pokémon Framework with Unity by Herbert Milhomme

=======

Pokémon Unity by IIcolour Spectrum

Created with Pokémon Framework

>>>>>>> alpha

Pokémon Unity is a game project made in Unity, that lets people make Pokémon-style games. It was created by IIcolour Spectrum (Lucas), who originally authored it from scratch starting from a Unity project. As of 2017, IIcolour Spectrum handed code development over to FlakFlayster, who then refactored the project into a framework library and based it on Pokémon Essentials code source, from RPG Maker. Currently, it is managed by Gen, and still updated by FlakFlayster.

Summary

Pokémon Framework is a framework written in C-Sharp and designed to be built on top of, as a foundation and key component in any Pokémon remake or emulator. Because the project is abstract, so loosely coupled from any frontend component, it allows for the project to easily migrate between any engine or platform that's C# compatible (i.e. Unity3d, Websites/ASP.Net, or even commandline console, as a text-based Pokémon battle simulator).

This contains a C# port of Pokémon Essentials to mirror the code to function the same (with very few and minor differences). I swapped out all of the data from Pokémon Essentials to use Veekun's Database, which is more expansive (more detailed, regularyly kept up-to-date, and formatted for database queries by default.

For additional context, this project rewrites Pokémon Essentials logic to implement Pokémon mechanics, using Veekun's Pokédex which rips data directly from Nintendo's Pokémon game, as foundation for Pokémon Framework. The game's text will be locally translated, through crowdsourcing that i've personally configured and setup on my own private webserver, which will return xml packages that can be downloaded and used as localized scripts by source. Then using GameFramework for Unity as a template, i will integrate the base Pokémon Framework to overwrite the template data to run like a Pokémon game, while feeding the behavior into the Pokémon Unity assets as final render and output (game .exe compile). If you have any experience with Pokémon Essentials, but with a perference for Unity or C#, then this is the project for you. End users are still required to have an aptitude or interest in hardwork. As in, this project isnt making a game for you, or shipping you with a completed game to enjoy and experience; this is a FRAMEWORK you still have to put in effort to make your own "game" (and why the source codes and dll are being uploaded and not a link to an .exe download).

I'm basing the code mimic and emulate the Pokémon Essentials package for RPG Maker MV, which is written in Ruby. But since Ruby follows similar object-oriented coding structures, it's easy to mirror the code to function the same.

This Project with Pokemon Framework

I use IIcolour Spectrm's orginal Pokemon Unity as a base with Herbertmilhomme's framework. So far, this project use wrapper (Legacy <=> Framework) and in future, I want to remove wrapper.

This project is playable, but it has some issues and some features are disabled.

I recommend to not use this project as base to build a game, yet.

My next plan

• Fix save file system
• Remove the wrapper
• Refactor Backend scripts
• Rewrite UI scene scripts
• Fix the known bugs

How to open the project and play a demo

For Unity: (2018.3.7f1)

• Use Unity Hub or Editor to import this project's folder (/Pokemon Unity)
• You will need to move database to ..\ ..\ ..\\veekun-pokedex.sqlite. (Found in /Pokemon Unity/Assets/Data) Latest Commit should fix the issue.
• Open startup.scene and play it

How to build and run the project

For Window:

• You build the project
• Open Build folder and copy SQLite.Interop.dll from YourAppName/YourAppName_Data/Plugins to YourAppName/YourAppame_Data/Managed
• Run YourAppName.exe

Credits

• PKUnity Project Lead: FlakFlayster
• PKUnity Base author: IIcolour Spectrum/superusercode
• PKUnity Maintainer: MyzTyn and Gen
• PKUnity Logo artist: Kaihatsu

Links

• Reddit: https://www.reddit.com/r/PokemonUnity/
• Discord server: https://discord.gg/AzW8Ds7MdE
• Project Board: Not Frequently Used or Updated
• Documentation: Pokémon Essentials Wiki (or My poorly written Github wiki)
• Documentation-Repo: https://github.com/herbertmilhomme/PokemonUnity/tree/gh-pages
• Database: Veekun's Pokédex Github
• Unity Framework: GameFramework UnityEngine C# Assets
• Unity Framework: GameFramework Vanilla C# Library
• Web-Server: TBD

Demo and Downloads

There are also demos for Windows, Linux, and Mac zipped in 2016 Release