lmachens / soc.gg

A Songs of Conquest fansite

SoC.gg - A Songs of Conquest fansite

• Website
• Discord
• Songs of Conquest
• Analytics

Features

• Full codex of all the game's units, skills, factions and wielders
• Spotlight search
• and more to come! Feel free to suggest new features.

We have the approval and support of the game studio (Lavapotion) to use the game data in this project 🤘.

Contribution

This app is Open Source. Contributors are highly welcome! You can find open tasks and issues on GitHub.

Join us on Discord if you like to contribute.

Development

First, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

The collection files in lib/collections are extracted from the game data. This is done by a different project, which is not part of the repository. If you require more information, please add an issue.

Game data extractor

This project is based on the game data of Songs of Conquest. See extractor/README.md for more information.

Environment variables

The following list shows the environment variables you can set. You can find more information on Environment Variables:

KEY	VALUE
NEXT_PUBLIC_PLAUSIBLE_HOST	Plausible API host (optional)
NEXT_PUBLIC_PLAUSIBLE_DOMAIN	Plausible domain (optional)

Analytics

If you are interested in the analytics of this project, please visit the dashboard. It's based on Plausible, a privacy-friendly analytics solution without the need of cookie banners or GDPR consent.

License

MIT

soc.gg's Issues

Intimidating, Inspiring and Reach have wrong descriptions

Intimidating, Inspiring and Reach have broken descriptions. The first two of those say only "Give friendly/enemy units within 1 hexagons:", but they do not say what will be given. Reach, on the other hand, says that +1 melee range is given to all friendly units within 1 hexagons, as opposed to +1 melee range for this unit only.

All three of these can be seen in one place on the dragon page.

(P. S.: Thanks for adding the ranged attack info so quickly!)

Monetize this project

It helps me to develop this and other projects if I earn a bit by adding ads or paid services.
For this project, ads should work fine.
I like the idea of closable ads, which works fine on https://aeternum-map.gg/.

This task has low priority.

Add lore

I found this reddit post and I think we could easily generate the lore from the extracted game data:
https://www.reddit.com/r/Songsofconquest/comments/vz35nh/i_made_a_pastebin_with_the_lore_text_in_the/

Pieces of untranslated text

While the main content of the site is available in multiple languages, some text is hardcoded into english. This includes the sidebar, search button and some others like "learn more" in the factions page.

Example, when browsing the site in portuguese:

Toughened Spirits level 3 missing "Speed" ability

Add missing spell/unit's essence information

It'd be more than useful to be able to check information about spells, their cost and their effect based on tier on soc.gg.
Units having information about what essence they generate would also be more than welcome

Lists not properly aligned on mobile

Some of the lists (wielders, skills, factions/wielders, factions/units) are not aligning left on smaller resolutions.
Example:

This only seems to happen when the screen is small enough for the sidebar to collapse. When it's present, everything works as expected:

Add patch notes to SoC.gg

Probably not required while the game is in Early Access, but it might be nice to keep a record of the balance changes on the page of every unit/building/spell. See the image for an example.

Alternatively, create a page exclusively for patch notes where we detail the version differences.

Add sitemap.xml and robots.txt for SEO

We can tell search machines like Google which pages are available on https://soc.gg and should be scraped.

A simple guide for Next.js:
https://nextjs.org/learn/seo/crawling-and-indexing/xml-sitemaps
https://nextjs.org/learn/seo/crawling-and-indexing/robots-txt

In short, we have to add two routes. The sitemap.xml.ts reads generates an XML for each route with getServerSideProps. The routes are similar to the links in the sidebar.
The robots.txt is static and could be added to the public folder.

If this task is done, I can submit the sitemap.xml to Google Search Console.

Level 3 Toughened Spirits upgrade lists "Quick ()" as the effect

On the Grand Armory page, the level 3 Toughened Spirits upgrade lists "Quick ()" as the effect. I don't know what that bonus is supposed to be, but "Quick ()" seems wrong.

Add details in skills popover on wielders details

On https://www.soc.gg/wielders/BaronSilverlink, you can hover skills:

I like the idea to display more details in this popover, maybe similar to the details on https://www.soc.gg/skills/Taxes.

The content of the popover are set here:
https://github.com/lmachens/soc.gg/blob/main/pages/wielders/%5Btype%5D.tsx#L87

Add possible skills in wielders details

Right now, we only display the starting skills of a wielder. But we could add all possible skills based on the skill pool.
The skill pools are already added to https://github.com/lmachens/soc.gg/blob/main/lib/collections/wielders.json, but it's required to adjust the type definition.

Add Links to Official Songs of Conquest website and Steam.

Should add links to the official game websites and store to promote the game

Add research

Hi, and thanks for this project!

I have a feature request:
It would be helpful to also see research, and maybe have a link between units and related research available to boost them.

Add ranged attack stats to unit pages

Currently, the unit pages (like Rangers) don't have any ranged attack stats in them (ranged offense, range, deadly range). This makes the unit pages of primarily ranged units (like the aforementioned Rangers) quite unhelpful, as the most important stats of these units are missing.

Since your JSONs with game data have that information in them, I guess this could be easily fixed; and for many of the units, it would make their pages much more useful than how they're now.

Barya random event "Windfall" not displaying correctly

The event should be titled "Windfall" and be located at https://www.soc.gg/random-events/Barya/Windfall

However, the page created is https://www.soc.gg/random-events/Barya/Description, and the event is titled with it's description

Add missing site terms

We started to translate site terms in #32, but there are some terms left, like meta description.

In addition, there are only English, German and Brazilian Portuguese translated for some terms. Other languages are missing.

Some Skills have themselves as a requirement

An example for this is "March" on Sla-Kin.

This problem already exists in the files produced by assetRipper

I haven't checked in game whether or not skills showing this behavior are unobtainable.

Two columns lists

We can think about adding more columns to the lists, like on the wielders page.

This is how it could look like:

This project is using Mantine as UI library. The main area is wrapped in a https://mantine.dev/core/container/, which limits the maximum width.
For this task, a https://mantine.dev/core/simple-grid/ could be useful.

I think this task only makes sense if the height of the columns are equal.

Add rewards and penalities to random events

In #92 , random events were introduced.
rewards and penalities are still missing.

Add building trees for each faction

Please add information for each building of each faction, it would really help in making builds for the game.
-Building name
-Cost
-Units that get produced
-Requirements of this building
-Upgrade cost
-Produce after upgrade

A similar overview is visible in the fandom wiki site, but its not close to finished and not that pretty

Add Faction and Unit Based Research Information

For example Barya's "Move Fast" Harima troop research gives +5 initiative each level but at third level it also gives them +1 troop movement. This isn't known until you've reached that research in game so an external tool with this info on it would be very good. Unit specific research especially is usually like this. For example Musketeer research grants +10 ranged offense, then +range, then +essence all completely different upgrades at each tier.

Add Random Events

Example:

Faction: Arleon
Name: Prize Hen
Description: A patrol stumble upon a village in celebration. They quickly find out what the ruckus is all about. A hen has layed a solid golden egg. The egg and the hen were swiftly claimed for the realm's profit.

In addition, details about triggers, recipient value, artefact types or penalities would be nice.

Full data extracted from game:

{
    "id": 2,
    "randomEventData": {
      "type": 1,
      "uniqueName": "Arleon/GoldenEgg/PrizeHen",
      "nameKey": "RandomEvents/Arleon/GoldenEgg/PrizeHen",
      "descriptionKey": "RandomEvents/Arleon/GoldenEgg/PrizeHen/Description",
      "eventChainNameKey": "RandomEvents/Arleon/GoldenEgg",
      "isReoccuring": 0,
      "chanceOfHappening": 0.08,
      "eventEvaluationTrigger": 0,
      "requirementEvaluationType": 0,
      "requirements": [
        {
          "requirementType": 7,
          "resourceType": 0,
          "entityType": 6,
          "artifactType": 7,
          "factionIndex": 0,
          "unitIndex": 0,
          "eventReference": {
            "uniqueName": null
          },
          "value": 5
        }
      ],
      "eventRecipient": 0,
      "recipientArtifactType": 7,
      "recipientFactionIndex": 1,
      "recipientUnitIndex": 1,
      "recipientTroopUpgradeType": 0,
      "recipientValue": 500,
      "reward": {
        "rewardDataList": []
      },
      "penalty": {
        "penaltyDataList": [
          {
            "penaltyType": 0,
            "resourcePenalty": {
              "type": 0,
              "amountMinMax": {
                "min": 500,
                "max": 800
              }
            },
            "destroyOwnedBuilding": {
              "buildingToDestroy": 0,
              "destroyAll": 0,
              "amount": 1
            },
            "createHostile": {
              "troop1": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop2": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop3": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop4": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop5": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop6": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop7": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop8": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "troop9": {
                "factionIndex": 0,
                "unitIndex": 0,
                "size": 0,
                "upgradeType": 0
              },
              "amountOfHostiles": 1,
              "spawnLocation": 0,
              "battleMapName": null
            },
            "createRandomHostile": {
              "faction": {
                "factionIndex": 1
              },
              "tier": 1,
              "maxUpgradeType": 0,
              "maxCost": 5000,
              "troopCount": 5,
              "amountOfHostiles": 1,
              "spawnLocation": 0,
              "battleMapName": null
            },
            "reduceRecruitmentPool": {
              "troopsToReduce": [],
              "percentage": 0
            }
          }
        ]
      }
    },
    "type": "GoldenEggPrizeHen"
  }

Add privacy-friendly tracking

For other apps, I am using plausible for analytics like page-view tracking.
Example:
https://apps.machens.dev/aeternum-map.gg

I like to know how many users are using this project.

Random event troop requirements displaying incorrectly

This is a Barya event, and it requires the unit with index 3 and faction 3. The faction is correctly mapped to barya, but the unit needs to be mapped to barya's 3rd unit (I think it's either dreath, brute, or sassanid.... probably brute), as opposed to arleons (ranger)

The problem also occurs in the random event descriptions of other factions like Loth

If possible, can we change it to something like
<recipient> produces <number> or more <unitName> per round?
So something like "Recipient (Team) produces 1 or more Brute or more per round"

Incomplete Skill Description for Essence Shield

https://www.soc.gg/skills/PowerShielded

Missing description text for the benefits of essence shield (Range resistance)

Add locale selector

This project already supports multiple locales, but you can not select a different locale.
Examples:
https://www.soc.gg/en/factions (English)
https://www.soc.gg/de/factions (German)

The locale is automatically detected. See https://nextjs.org/docs/advanced-features/i18n-routing#automatic-locale-detection for more details.

The available locales are equal to the locales in-game.
https://github.com/lmachens/soc.gg/blob/main/lib/collections/locale.json is generated from the game-assets.

The task is to create a locale/language selector to transit between locales.
Technically, we can add links to change the locale:
https://nextjs.org/docs/advanced-features/i18n-routing#transition-between-locales
I am open for ideas how to implement a selector on UI side.
One idea is to add a https://mantine.dev/core/action-icon/ with https://mantine.dev/core/popover/ next to the social icons (GitHub / Discord). I think a country flag would be nice here.
Icon packs:
https://github.com/lipis/flag-icons
https://www.npmjs.com/package/country-flag-icons

Support AssetRipper v0.2.3.0

Release Notes
https://github.com/AssetRipper/AssetRipper/releases/tag/0.2.3.0

In 0.2.2.0 they merged the Console and GUI projects which requires to update extractor/README.md.
AssetRipper/AssetRipper@e71a260

Add neutral entities

Add list of neutral entities filtered by temporary vs permanent buffs

Add details to unit pages

Right now, https://www.soc.gg/units/Barya/Sassanid and other unit pages doesn't display details except the name, icon and lore.

I would like to add the information displayed in the in-game codex.
This task requires to update the type definition in:
https://github.com/lmachens/soc.gg/blob/main/lib/units.ts and add missing properties for purchaseCost, obsoleteGoldCost, stats and troopAbility. This data is already in https://github.com/lmachens/soc.gg/blob/main/lib/collections/units.json

For legal compliance, add link to Privacy policy, Attributions, and Disclaimers

Standard practice to add a link to a privacy policy that explains if information is user session info is tracked, exactly what information is tracked, and how to opt out.

Attributions should also be listed for content that is used on website that is not owned by the website's developers including images and libraries.

Disclaimers are also common, explaining who owns the intellectual property.

This information is all commonly placed in a footer or header.

Missing unit skill description and HTML leftovers

Some units have HTML like <span class="positive">+1</span> Attacks (https://www.soc.gg/en/units/Arleon/FaeySpirit). This is alread converted on other pages like the stats.
Other units have missing skill descriptions like Helpless on https://www.soc.gg/units/Barya/Hellbreath

Add a home landing page

Add a landing page for https://soc.gg/ Currently the Factions details are the default landing page.

This would be a good place to add links to official Songs of Conquest websites and discord.

display skills as a tree

It would be much quicker and easier to understand if skill dependencies were shown as a graph

List of related random events on other pages

Factions, buildings and more are related to random events.
https://www.soc.gg/random-events/Arleon/BaryanMerchant requires 2 marketplaces, so it could make sense to add a list of events to the marketplace page: https://www.soc.gg/buildings/Arleon/Marketplace

Add troop ability and status on units page

The data structure of the units needs to include the full status and troop ability before we can display them.