https://eugeneration.github.io/HappyIslandDesigner/

https://eugeneration.github.io/HappyIslandDesigner/

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://eugeneration.github.io/HappyIslandDesigner/
• Owner: eugeneration
• License: mit
• Created: 2020-02-25T03:16:28.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T19:37:09.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T14:43:12.529Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://eugeneration.github.io/HappyIslandDesigner/
• Size: 54.7 MB
• Stars: 840
• Watchers: 17
• Forks: 147
• Open Issues: 109
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-acnh - **Happy Island designer** - map in the browser. (Resources and guides / Layout)

README

        
# Happy Island Designer (Alpha)

Create your own at:

https://eugeneration.github.io/HappyIslandDesigner/

Report bugs in the Issues tab or on the [Discord](https://discord.gg/EtaqD5H)

![screenshot](thumbnail.png)

## Introduction

Once I saw that you could customize your island in the AC direct, I was inspired to make a tool that lets you make your own island. Several dozen hours of work later, I have this! This is an alpha build, so some things may be wonky, and the maps data may become incompatible with future versions.

Click here for [technical details](/docs/README-technical.md).

Click here for [local development info](/docs/README-localdev.md).

## Features

* autosave

* undo/redo

* zooming

* Choose between flat icons or high quality renders for building icons

* Save an image of a map and load the image back in to recover your map (the map data is encoded in the image)

* Click the tool icon a second time to hide the pop out tool menu

* Brush size selector

* Line toggle buttons

* Mobile - pinch to zoom and two finger swipe to scroll

### Hotkeys

* Hold `SHIFT` to draw straight lines

* Hold `ALT` and click a color to switch to it

* Hold `ALT` and scroll to zoom

* Hold `SPACEBAR` and drag to pan

## Known Issues

**Note that if you edit/compress the saved image, the encoded data will get corrupted.** If you're sharing a map, make sure to use an image host that doesn't compress the image.

The UI isn't really optimal for mobile, but at least it works.

The UI will be cut off if you hold your phone in landscape mode.

## FAQ

### The browser crashes every time I open it!

The autosave file might be corrupted. Open the browser console (hit `F12`) and run this command `editor.clearAutosave()` to remove your autosave file.

## Future Enahancements

* Choose from multiple starting templates

* All the icons

* Island name banner

* Text labels

* UI overhaul

* Isometric view??

## Contribute

Please let me know if something isn't working or if you have any feedback!

### Sprites

I am in dire need of icons for all the buildings/plants. If any of you have nice looking icons and are willing to share, I'd like to use them (and of course give you credit).

### Maps

People could help me by recreating these 24 maps and sending me the map data, either by sending me a non-compressed version of the image file or pressing `/` and grabbing the map data that will be output in the browser console. Then I can offer all of these templates in a menu.

![base maps](/docs/base-nh-maps.png)

To see which maps have already been contributed, please reference [issue #59](https://github.com/eugeneration/HappyIslandDesigner/issues/59).