Repository files navigation

🛠 Under active development

In this top-down, story-driven shooter, you play as Pop Pixie, the rightful inheritor of the Pop™ brand of soda. Your mission is to infiltrate the headquarters of the evil Mentoes Corporation, avenge the death of your father, and bring the company’s dark secrets to light.

Mr Mentoe and his minions will do everything in their power to put a stop to your mission. Fight back with an expansive arsenal of fizzing firearms and soda-themed weapons.

But you can’t do it alone. Masterminding your mission is Amanda, who will stop at nothing to put an end to the corrupt corporatocracies that carelessly destroy families like hers every day.

• Fight your way through swarms of bloodthirsty gremlins
• Outsmart and outmanoeuvre ruthless bosses
• Unlock an expansive arsenal of fizzing firearms and soda-themed weapons
• Learn the dark secrets behind the Mentoes Corporation

🎮 Our demo gamePop Pixie: Mission Training is now available to download and play fromSteam or from ourwebsite.

Update July 2024: Now that the demo is released, all our attention is focused on getting the first few levels of the main game finished. We'll be releasing the game incrementally using Early Access on Steam.

Follow us on social media for more updates:

• Steam
• Discord
• Twitter
• Website

Follow these instructions to run Pop Pixie locally.

1. Install the latest version ofUnity Hub
2. Inside Unity Hub, click Open and select Pop Pixie
3. Follow the instructions to install the version of Unity Editor currently used by Pop Pixie
   • When prompted to add modules, if you wish to compile standalone builds of Pop Pixie, select the following:
     • Mac Build Support (IL2CCP)
     • Windows Build Support (Mono)
4. When you open Pop Pixie, there will be compile errors. Click Ignore when Unity prompts you about these to open the Unity editor.

Due to incompatible licensing, some components and assets required by Pop Pixie cannot be included in this GitHub repo. These dependencies should be acquired separately and placed in the/Assets/vendor/ directory.

To check which dependencies are currently missing, runruby Assets/vendor/validate.rb.

When adding a dependency purchased through the Asset Store, import it using Unity's Package Manager under My Assets. Generally, it's safe to uncheck any directories labelled "Documentation" and "Examples", and including these in the import may increase compile time.

Unity will automatically place these dependencies in/Assets, but you should move them into/Assets/vendor to ensure they aren't committed to Git. FMOD is an exception to this, and may be placed in/Assets/Plugins, which is the default location.

We use Rewired for handling user input in Pop Pixie. Without it, the game will not compile and keyboard, mouse and controller input will not work. The free trial stops working after five minutes of runtime, which is the only limitation.

Purchase fromhttps://guavaman.com/projects/rewired/

Move from/Assets/Rewired to/Assets/vendor/Rewired

When there are no more compile errors, Rewired will prompt you to begin installation. Please skip this step.

We use Retro: CRT TV for the CRT effect in Pop Pixie. Without it, Access Terminal screens won't render correctly, but will still be legible.

Purchase fromhttps://assetstore.unity.com/packages/vfx/shaders/fullscreen-camera-effects/retro-crt-tv-241411

Move from/Assets/FronkonGames to/Assets/vendor/FronkonGames

We use FMOD for all audio in Pop Pixie. Without it, the game will not compile and there will be no audio.

Get fromhttps://assetstore.unity.com/packages/tools/audio/fmod-for-unity-161631

Import to/Assets/Plugins, which is the default location.

When you import FMOD, it will make a minor change to/Assets/Resources/FMODStudioSettings.asset. This change is harmless, but should not be committed. Revert the change using Git.

$ git checkout -- Assets/Resources/FMODStudioSettings.asset

The city background used in some scenes in Pop Pixie is modified from the Pixel Art City Backgrounds asset pack by edermunizz. Due to the license under which this asset pack is sold, we're unable to include our modified version of the city background in this GitHub repo. The game will still run without the background, but some scenes will be rendered incorrectly.

Purchase fromhttps://edermunizz.itch.io/pixel-art-city-backgrounds. If you send us proof that you have done so, we will give you a copy of the modified background.

Expected file structure:

/Assets/vendor/Main Menu Background├── Lights 1.png├── Lights 2.png├── Lights 3.png├── Lights 4.png├── Lights 5.png├── Lights 6.png├── Lights 7.png├── Lights 8.png├── Lights 9.png├── Lights 10.png├── Main Menu Background.png└── Tower M.png

We use TextMesh Pro for rendering text in Pop Pixie.

Import by selecting TextMeshPro > Import TMP Essential Resources

Move from/Assets/TextMesh Pro to/Assets/vendor/TextMesh Pro

DOTween is a dependency of TMP_Typewriter, which we'll be installing shortly. Since DOTween's website does not support HTTPS and so downloading executable code from there carries significant risk, we provide acompiled mirror of the version of DOTween used by Pop Pixie.

Add by runninggit clone https://github.com/anderbellstudios/DOTween Assets/vendor/DOTween in the root of the project

We use TMP_Typewriter for the typewriter effect used in Pop Pixie's dialogue box and other places.

DownloadTMP_Typewriter_v1.0.0.unitypackage fromhttps://github.com/baba-s/TMP_Typewriter/releases and import using Unity

Move from/Assets/TMP_Typewriter to/Assets/vendor/TMP_Typewriter

We use JsonDotNet (otherwise known as Newtonsoft.Json) for various internal subsystems of Pop Pixie, mainly save data storage and data collection.

Download fromhttps://github.com/JamesNK/Newtonsoft.Json/releases

If there are compiled binaries for multiple .NET versions, use the latest 4.x version.

Place any assemblies in/Assets/vendor/JsonDotNet

If you installed all of those dependencies correctly,ruby Assets/vendor/validate.rb should have no output and there should be no compile errors in the Unity console. (It's safe to ignore any warnings.)

Unity may have modifiedProjectSettings/ProjectSettings.asset when starting up Unity. Please revert these changes usinggit checkout -- ProjectSettings/ProjectSettings.asset.

At this point,git status should report that the working tree is clean. Please try to resolve any inconsistencies if this is not the case.

You should now be ready to begin work on Pop Pixie. Open a Unity scene from/Assets/Unity/Scenes to get started.

When updating the app verison, it should be modified inProjectSettings.asset andpop-pixie.iss.

The in-game version checker useshttps://github.com/anderbellstudios/pop-pixie/blob/version/VERSION.

This project is tested with BrowserStack.