@fishies/ui 0.8.3

package/dist/icons.generated.js

@@ -0,0 +1,658 @@
+export const ICON_FACTS = {
+    "feed": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "net": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "clean": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "decorate": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "arrange": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "remedy": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "inspect": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "home": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "explore": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "map": {
+        "px": 320,
+        "sharpTo": 160,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "shop": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "cart": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "cart-add": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "inventory": {
+        "px": 56,
+        "sharpTo": 28,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "book": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "people": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "share": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "pin": {
+        "px": 40,
+        "sharpTo": 20,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "menu": {
+        "px": 52,
+        "sharpTo": 26,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "bell": {
+        "px": 52,
+        "sharpTo": 26,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "gear": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal",
+            "Video player"
+        ]
+    },
+    "help": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "sound": {
+        "px": 52,
+        "sharpTo": 26,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal",
+            "Video player"
+        ]
+    },
+    "mute": {
+        "px": 52,
+        "sharpTo": 26,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Video player"
+        ]
+    },
+    "music": {
+        "px": 52,
+        "sharpTo": 26,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "fullscreen": {
+        "px": 52,
+        "sharpTo": 26,
+        "usedBy": [
+            "Game",
+            "Video player"
+        ]
+    },
+    "camera": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "coin": {
+        "px": 80,
+        "sharpTo": 40,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "fish": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal",
+            "Video player"
+        ]
+    },
+    "egg": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "growth": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "heart": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "star": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "shell": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "kelp": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "coral": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "lock": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "solved": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "staff": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "edit": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "upvote": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "report": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "follow": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "views": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "chat": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "announce": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "updates": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "bug": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "idea": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "reply": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "quote": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "clock": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "showcase": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "tank": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "block": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Reef Journal"
+        ]
+    },
+    "trash": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "link": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "smile": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "send": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Reef Journal"
+        ]
+    },
+    "whisper": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "wave": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Reef Journal"
+        ]
+    },
+    "thermometer": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "drop": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "warning": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "gift": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "gem": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "trophy": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Reef Journal"
+        ]
+    },
+    "level": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "quest": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "check": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Video player"
+        ]
+    },
+    "keeper": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS"
+        ]
+    },
+    "exit": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "globe": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "search": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Keeper OS",
+            "Reef Journal"
+        ]
+    },
+    "sell": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game",
+            "Reef Journal"
+        ]
+    },
+    "keyboard": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "external": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "add": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "download": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": []
+    },
+    "mail": {
+        "px": 168,
+        "sharpTo": 84,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-hello": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-heart": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-question": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-surprise": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-food": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-sleep": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-music": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    },
+    "emote-sparkle": {
+        "px": 128,
+        "sharpTo": 64,
+        "usedBy": [
+            "Game"
+        ]
+    }
+};

package/dist/icons.js

@@ -0,0 +1,53 @@
+export const ICON_GROUPS = [
+    { id: 'care', title: 'Care tools', use: 'The verbs of keeping fish: the dock’s tools and the cursors they become.' },
+    { id: 'places', title: 'Places and lists', use: 'Where you can go and what you can open: rooms, shop, stash, map, people.' },
+    { id: 'system', title: 'System', use: 'Settings, sound, notices and the frame: the same in the game, the OS and the player.' },
+    { id: 'things', title: 'Things', use: 'Nouns of the reef: coins, fish, eggs, plants, rewards.' },
+    { id: 'expressions', title: 'Expressions', use: 'The emotes keepers send in Open Water and the chat.' },
+];
+const ui = (name, label, group, meaning) => ({ name, file: `/game/ui-icons/${name}.png`, label, group, meaning });
+const emote = (name, label, meaning) => ({ name: `emote-${name}`, file: `/game/emotes/${name}.png`, label, group: 'expressions', meaning });
+export const SYSTEM_ICONS = [
+    ui('feed', 'Feed', 'care', 'give fish food'), ui('net', 'Net', 'care', 'catch a fish to sell or move'), ui('clean', 'Clean', 'care', 'wipe the glass'),
+    ui('decorate', 'Decorate', 'care', 'place a new decoration'), ui('arrange', 'Arrange', 'care', 'move what is already placed'),
+    ui('remedy', 'Remedy', 'care', 'heal a sick fish'), ui('inspect', 'Inspect', 'care', 'look closer at a fish'),
+    ui('home', 'Home', 'places', 'your own aquarium'), ui('explore', 'Explore', 'places', 'find other keepers'), ui('map', 'Map', 'places', 'the ocean map and its places'),
+    ui('shop', 'Shop', 'places', 'buy fish, decor and care'), ui('cart', 'Cart', 'places', 'open the basket'), ui('cart-add', 'Add to cart', 'places', 'put something in the basket'),
+    ui('inventory', 'Stash', 'places', 'what you own but have not placed'), ui('book', 'Book', 'places', 'the Reef Journal and guides'),
+    ui('people', 'People', 'places', 'keepers, friends, followers'), ui('share', 'Share', 'places', 'send a link elsewhere'), ui('pin', 'Pin', 'places', 'keep it on top'),
+    ui('menu', 'Menu', 'system', 'more choices'), ui('bell', 'Notices', 'system', 'what happened while you were away'), ui('gear', 'Settings', 'system', 'change how it works'),
+    ui('help', 'Help', 'system', 'ask or learn how'), ui('sound', 'Sound', 'system', 'sound is on'), ui('mute', 'Muted', 'system', 'sound is off'),
+    ui('music', 'Music', 'system', 'the soundtrack'), ui('fullscreen', 'Full screen', 'system', 'fill the screen'), ui('camera', 'Camera', 'system', 'take a picture or a video'),
+    ui('coin', 'Coin', 'things', 'money in the game'), ui('fish', 'Fish', 'things', 'a fish, the game itself'), ui('egg', 'Egg', 'things', 'an egg, something hatching'),
+    ui('growth', 'Growth', 'things', 'growing up, rising numbers'), ui('heart', 'Heart', 'things', 'a like, kindness'), ui('star', 'Star', 'things', 'level, favourite, reward'),
+    ui('shell', 'Shell', 'things', 'a shell, reef chat'), ui('kelp', 'Kelp', 'things', 'plants'), ui('coral', 'Coral', 'things', 'coral and ornaments'),
+    ui('lock', 'Locked', 'system', 'closed, cannot be changed or answered'), ui('solved', 'Solved', 'things', 'answered, done, approved'),
+    ui('staff', 'Staff', 'things', 'someone from the Fishies team'), ui('edit', 'Edit', 'system', 'change words, or was changed'),
+    ui('upvote', 'Upvote', 'things', 'this is useful, raise it'), ui('report', 'Report', 'system', 'tell the team something is wrong'),
+    ui('follow', 'Follow', 'system', 'get notices about it'), ui('views', 'Views', 'things', 'how many looked, who can see it'),
+    ui('chat', 'Chat', 'places', 'a conversation, replies, general talk'),
+    ui('announce', 'Announcements', 'places', 'news from the team'), ui('updates', 'Updates', 'places', 'patch notes and what changed'),
+    ui('bug', 'Bugs', 'places', 'something broken'), ui('idea', 'Ideas', 'places', 'a suggestion'),
+    ui('reply', 'Reply', 'system', 'answer this'), ui('quote', 'Quote', 'system', "repeat someone's words in yours"),
+    ui('clock', 'Time', 'system', 'when, how long, last activity, away'), ui('showcase', 'Showcase', 'places', 'show what you made'),
+    ui('tank', 'Aquarium', 'things', 'an aquarium you own or buy'), ui('block', 'Block', 'system', 'block a keeper, ban'),
+    ui('trash', 'Remove', 'system', 'remove, delete'), ui('link', 'Link', 'system', 'copy or open a link'),
+    ui('smile', 'Emoji', 'system', 'pick an emoji'), ui('send', 'Send', 'system', 'send a message or post'),
+    ui('whisper', 'Whisper', 'places', 'a private message'), ui('wave', 'Open water', 'places', 'open water, the reef lane'),
+    ui('thermometer', 'Temperature', 'care', 'water temperature, the heater'), ui('drop', 'Water', 'care', 'water quality'),
+    ui('warning', 'Warning', 'system', 'warning, danger'), ui('gift', 'Gift', 'things', 'gifts, something given'),
+    ui('gem', 'Grade', 'things', 'quality tier, grade'), ui('trophy', 'Trophy', 'things', 'achievements, badges'),
+    ui('level', 'Level', 'things', 'level, XP, level-up'), ui('quest', 'Quest', 'things', 'a quest, a goal'),
+    ui('check', 'Done', 'system', 'done, selected, met'), ui('keeper', 'Keeper', 'places', 'an account, a person'),
+    ui('exit', 'Leave', 'system', 'sign out, quit, leave'), ui('globe', 'Language', 'system', 'language, all languages'),
+    ui('search', 'Search', 'system', 'search'), ui('sell', 'Sell', 'care', 'sell, a price'),
+    ui('keyboard', 'Keys', 'system', 'shortcuts and keys'), ui('external', 'Opens elsewhere', 'system', 'opens in a new tab'),
+    ui('add', 'New', 'system', 'new, create'), ui('download', 'Download', 'system', 'download'), ui('mail', 'Mail', 'system', 'email, the newsletter'),
+    emote('hello', 'Hello', 'wave hello'), emote('heart', 'Love', 'send love'), emote('question', 'Question', 'wonder aloud'), emote('surprise', 'Surprise', 'be surprised'),
+    emote('food', 'Food', 'ask for food'), emote('sleep', 'Sleepy', 'feel sleepy'), emote('music', 'Music', 'enjoy the music'), emote('sparkle', 'Sparkle', 'something wonderful'),
+];
+export const ICON_SIZES = { xs: 16, sm: 20, md: 28, lg: 46, xl: 84 };
+export const iconByName = (name) => SYSTEM_ICONS.find(icon => icon.name === name);
+let resolveUrl = (icon) => icon.file;
+export function configureIcons(options) { resolveUrl = options.url; }
+export const iconUrl = (icon) => resolveUrl(icon);