Amaranth 1.0

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/ISSUE_TEMPLATE/BugReport.yml

@@ -9,14 +9,14 @@ body:
     id: current
     attributes:
       label: Current behavior
-      description: Describe the current faulty beharior of Valkyrie.
+      description: Describe the current faulty beharior of Amicons.
     validations:
       required: true
   - type: textarea
     id: expected
     attributes:
       label: Expected behavior
-      description: Describe the expected beharior of Valkyrie.
+      description: Describe the expected beharior of Amicons.
     validations:
       required: true
   - type: textarea
@@ -40,7 +40,7 @@ body:
   - type: checkboxes
     id: implementations
     attributes:
-      label: Which parts of Valkyrie are affected?
+      label: Which parts of Amicons are affected?
       options:
         - label: Web fonts and CSS
           required: false
@@ -56,9 +56,9 @@ body:
     attributes:
       label: Bug report checklist
       options:
-        - label: This bug occures in the latest version of Valkyrie.
+        - label: This bug occures in the latest version of Amicons.
           required: true
         - label: The reproduction is included and is the minimum test case to recreate the faulty behavior.
           required: true
-        - label: I have [searched the issues](https://github.com/sippy-platform/valkyrie/issues) for any possible duplications of this bug report.
+        - label: I have [searched the issues](https://github.com/studio384/amicons/issues) for any possible duplications of this bug report.
           required: true

.github/ISSUE_TEMPLATE/FeatureRequest.yml

@@ -1,5 +1,5 @@
 name: Feature Request
-description: Suggest a new idea for Valkyrie.
+description: Suggest a new idea for Amicons.
 title: "[Feature] "
 labels: [feature]
 assignees:
@@ -32,5 +32,5 @@ body:
       options:
         - label: This is a single feature.
           required: true
-        - label: I have [searched the issues](https://github.com/sippy-platform/valkyrie/issues) for any possible duplications of this feature request.
+        - label: I have [searched the issues](https://github.com/studio384/amicons/issues) for any possible duplications of this feature request.
           required: true

.github/ISSUE_TEMPLATE/IconRequest.yml

@@ -1,6 +1,6 @@
 name: Icon Request
 description: Request a new icon to be added to the set.
-title: "[Icon] Add vi-"
+title: "[Icon] Add ai-"
 labels: [icon, external]
 assignees:
   - studio384
@@ -32,7 +32,7 @@ body:
       options:
         - label: This is a single icon or part of an expected pair (e.g. `eye` and `eye-slashed`).
           required: true
-        - label: I have [searched the issues](https://github.com/sippy-platform/valkyrie/issues) for any possible duplications of this icon request.
+        - label: I have [searched the issues](https://github.com/studio384/amicons/issues) for any possible duplications of this icon request.
           required: true
         - label: An example image is included if available.
           required: false

.github/workflows/deploy.yml

@@ -0,0 +1,75 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: ['1.0']
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm install
+      - name: Production build
+        run: npm run prod
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: amicons
+          path: |
+            dist
+            node_modules
+
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Download artifact
+        id: download
+        uses: actions/download-artifact@v4
+        with:
+          name: amicons
+      - name: Install dependencies
+        if: steps.download.outcome == 'success'
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/dist
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,2 +1,6 @@
-/node_modules
-/dist
+.DS_Store
+/.hugo_build.lock
+/_site/
+/node_modules/
+/resources/
+/dist/

.svg-to-tsrc

@@ -1,11 +1,11 @@
 {
   "srcFiles": ["./icons/**/*.svg"],
   "outputDirectory": "./src",
-  "interfaceName": "ValkyrieIcon",
-  "typeName": "Valkyrie",
-  "prefix": "vi",
-  "fileName": "Valkyrie",
+  "interfaceName": "IAmicon",
+  "typeName": "Amicons",
+  "prefix": "ai",
+  "fileName": "Amicons",
   "additionalModelFile": "./src",
   "compileSources": true,
-  "completeIconSetName": "valkyrieSet"
-}
+  "completeIconSetName": "amiconSet"
+}

README.md

@@ -1,20 +1,17 @@
-# Valkyrie
+# Amicons
 An open source icon set for the next generation of Sippy.
 
 # Usage
-Install Valkyrie with the following npm command.
+Install Amicons with the following npm command.
 
 ```
-npm install @sippy-platform/valkyrie
+npm install @studio384/amicons
 ```
 
-Valkyrie includes a number of ways to use it. Our package will include the individual SVG files, a React-component and JavaScript implementation with TypeScript definitions, as well as an old-school webfont.
-
-# 216 icons
-[Available on Figma](https://www.figma.com/file/jeP1aSRulegRxHDegrrmWc/Valkyrie?node-id=1%3A11358)
+Amicons includes a number of ways to use it. Our package will include the individual SVG files, a React-component and JavaScript implementation with TypeScript definitions, as well as an old-school webfont.
 
 # About
-Valkyrie is an iconset designed for use in the Mellow Design Language. Our goal is to provide a highly-optimized set of icons that are custom made for Sippy and any future environments required. As such, Valkyrie will mostly include iconography related to basic UI (arrows, menu icons, etc.) and phone iconography (voicemail, call directions, etc.).
+Amicons is an icon set built for ChangeWindows, Starscout and more projects, sharing code with [Valkyrie](https://github.com/sippy-platform/valkyrie) and the original ChangeWindows Amaranth project.
 
 # License
 AGPL v3

build/generate-library.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+"use strict";
+
+const fs = require("fs").promises;
+const fst = require("fs");
+const path = require("path");
+const picocolors = require("picocolors");
+
+const iconsDir = path.join(__dirname, "../docs/public/data/icons");
+const pagesDir = path.join(__dirname, "../docs/src/data/");
+
+function getReactImportName(string) {
+  return `ai${string
+    .split("-")
+    .map(word => {
+      return word[0].toUpperCase() + word.substring(1);
+    })
+    .join("")}`;
+}
+
+async function main(file) {
+  const iconFilePath = path.join(iconsDir, file);
+  const iconFile = fst.readFileSync(iconFilePath);
+
+  let iconJson = {};
+
+  try {
+    iconJson = JSON.parse(iconFile);
+  } catch (e) {
+    console.log(iconFilePath);
+  }
+
+  const iconBasename = path.basename(file, path.extname(file));
+  const iconTitle = getReactImportName(iconBasename);
+
+  const jsonTemplate = `
+  {
+    component: '${iconTitle}',
+    categories: ${JSON.stringify(iconJson.categories)},
+    tags: ${JSON.stringify(iconJson.tags)},
+    slug: '${iconBasename}',
+    icon: ${iconTitle}
+  }`;
+
+  return [`${iconTitle}`, jsonTemplate, iconJson.categories];
+}
+
+(async () => {
+  try {
+    const timeLabel = picocolors.cyan(`Library generation finished`);
+
+    console.log(picocolors.cyan(`Library generation started`));
+    console.time(timeLabel);
+
+    const files = await fs.readdir(iconsDir);
+
+    const names = [];
+    const configs = [];
+    let categories = new Set();
+
+    // Read content from each icon
+    await Promise.all(
+      files.map(async file => {
+        const [name, config, cats] = await Promise.resolve(main(file));
+
+        names.push(name);
+        configs.push(config);
+
+        cats.map(cat => {
+          categories.add(cat);
+        });
+      })
+    );
+
+    categories = Array.from(categories).sort();
+
+    const library = `
+import { ${names.map(icon => `${icon}`)} } from '@studio384/amaranth';
+
+const icons = [${configs.map(page => `${page}`)}
+];
+
+export default icons;`;
+
+    await fs.writeFile(path.join(pagesDir, `icons.ts`), library);
+
+    const categoriesTemplate = `
+import { aiCircleDashed } from '@studio384/amaranth';
+
+const categories = [${categories.map(
+      cat => `
+  {
+    slug: "${cat}",
+    title: "${cat}",
+    icon: aiCircleDashed
+  }`
+    )}
+];
+
+export default categories;`;
+
+    // await fs.writeFile(path.join(pagesDir, `categories.ts`), categoriesTemplate)
+
+    const filesLength = files.length;
+
+    console.log(
+      picocolors.green("\nSuccess, %s icon%s written to library!"),
+      filesLength,
+      filesLength !== 1 ? "s" : ""
+    );
+    console.timeEnd(timeLabel);
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+})();