Animal Crossing PC Port

<div align="center"> <img src="assets/nookery-logo.png" alt="Nookery" width="800"> </div>

Nookery (formerly known as ACGC-PC-Port) is a native Windows/Linux/macOS/Android/iOS port of Animal Crossing (GameCube), based on the ac-decomp decompilation.

This repository contains no game assets. A legally obtained GAFE01 Rev 0 (USA) disc image is required. RVZ, ISO, CISO and GCM images are supported.

Running the port for players

• Download the latest release in the Releases page.
• Extract Nookery.
• Optionally download the texture pack (Highly recommended, made by extremely talented artists, it looks really good.) and put the extracted files under {your_data_folder}/texture_pack
• Run Nookery. You'll need to select your legally obtained Animal Crossing copy to play the game.

Nookery includes various toggleable quality of life changes, we recommend taking a look under gameplay tab in settings. You might also want to take a peek at features to have an idea about what to expect.

If you have a save you want to import, you can drop them under {your_data_folder}/saves/card_a. You can also use card_b for the towns you want to visit.

If you are having issues with your controller/Steam Deck acting weird with inputs, try closing steam, or adding Nookery as a non-steam game.

On iOS, see INSTALLING_IOS.md to install the .ipa with iloader.

Building and running for developers

See BUILDING.md for Windows, Linux, and macOS, BUILDING_ANDROID.md for Android, and BUILDING_IOS.md for iOS. You can use Nookery --help to see available command line options after building.

Data Folder

The data folder holds saves, config.json, input.json, texture_pack/, and nes_roms/. Its default location is:

Platform	Default data folder
Windows	The executable's folder
macOS	~/Library/Application Support/Nookery/
Linux	~/.local/share/Nookery/
Android	The app's internal files directory, exposed through its system documents provider
iOS	The app's Documents folder, visible in the Files app under On My iPhone (or iPad) > Nookery

For android, you might need to use a different file browser app such as Material Files if you can't see internal files of Nookery.

On desktop, use Settings > Data to move game data to a custom folder.

Save Data

Your main town is at save/card_a/ in the data folder. We support .gci files, you can just use your dolphin save if you are migrating. You can put multiple towns in save/card_b/ to visit them in game.

Features

• Native 64-bit Windows, Linux, macOS, Android and iOS support, with Vulkan, D3D12, D3D11 and Metal renderers via Aurora
• Widescreen support
• Unlocked framerate
• Borderless acres
• Dolphin HD texture pack support
• Full mouse support for walking, inventory and all of the overlays
• Keyboard support for typing letters
• Controller support with hotplug, button remapping and stick deadzones
• Touch controls on Android/iOS, with a layout editor and vibration
• Built-in NES emulator that allows loading your own ROMs from the nes_roms folder
• Multiple towns in Card B so you can select where you want to visit easily
• Ability to visit the island without a GBA
• Extended date support up to year 3000
• Custom UI
• Update checker for new releases
• Quality-of-life options: fast text, single-player shop upgrades, optional Resetti, outdoor camera control, tool switch with D-pad and more!

Credits

This project would not be possible without the work of the ACreTeam decompilation team. Thanks to everyone who worked on that project.

Even though Cuyler is already included in ACreTeam, his contributions go well beyond decompilation side. He gave me access to deluxe's code even though he had no reason to (the reason this port got so much QoL from deluxe mod!), and was always helpful whenever I had questions about how the game worked. It was a lot of fun working together,
thanks man.

Also special thanks to Encounter for handling so much of the Aurora migration and their massive help, Tom Lube for extensive private testing, Aurora developers, Dusklight team for both their help and advice, and all contributors. This project couldn't get where it is without you.

Nookery icon and in game signs has been made by Rainy Ram.

Old ACGC logo has been made by @YourPalFox.

Thanks to both of them, they are really talented and I would highly recommend checking them out.

And lastly, shoutout to Animal Crossing Modding Discord members for being such a chill community!

AI Notice

This project had AI assistance during development (PC port code only).

FAQ

See FAQ for more info.

<br/> <div align="center"> <a href="https://github.com/encounter/aurora"> <img src="assets/aurora-powered.png" alt="Powered by Aurora" width="800"> </a> </div>