AGENTS.md — EclipticaPage
AGENTS.md — EclipticaPage
Instructions for AI agents and contributors working in this repository.
1. Project overview
EclipticaPageis the official landing page of the video game Ecliptica (first-person open-world colony survival simulator, QuasarApp Core, 2026 release).- Live site: https://ecliptica.me (custom domain set in
CNAME). - Stack: Jekyll 4.3 static site,
minimatheme base, pluginsjekyll-seo-tag,jekyll-sitemap,jekyll-feed. Deployed to GitHub Pages automatically on push tomainby.github/workflows/jekyll-gh-pages.yml. - This is a website repository: no game code, no CMake, no Qt, no Python. Do not add build systems, package managers (npm), or scripts that do not belong to the Jekyll workflow.
2. Repository layout (what touches the page)
| Path | Role |
|---|---|
_data/translations.yml |
Single source of truth for all visible text, 14 languages |
_layouts/default.html |
<head> SEO, hreflang, navbar, language switcher, lightbox markup |
_layouts/landing.html |
Page sections (hero, features, trailer, visuals, FAQ, social, footer) — pulls keys via site.data.translations[page.lang] |
index.md |
English (root) page; be/ de/ el/ es/ fr/ hi/ it/ jp/ pl/ ru/ sr/ ua/ zh/index.md — one per language, only sets lang: in frontmatter |
assets/css/style.css |
All styling; CSS variables (--secondary, --glass-border, fonts) are shared — extend, don’t fork |
assets/js/main.js |
Background trailer video, language switcher + auto-detect (supportedLangs), scroll effects, spawn/reveal animations, screenshot lightbox, lore console easter egg |
assets/sceenshots/ |
Gameplay screenshots. Directory name sceenshots (misspelled) is historical and referenced from _layouts/landing.html — do not rename without updating the layout in the same commit |
sw.js / manifest.json |
PWA service worker (network-first) and web app manifest |
ai.txt / robots.txt / indexnow_key.txt / _includes/game_schema.html |
SEO + AI crawler context — keep in sync with game facts, never delete |
3. Developing process
- Work on branch
task_<issue-number>created strictly frommain(rungit pullfirst). - Make minimal, reviewable diffs. One concern per commit.
- Copy/text changes: edit
_data/translations.ymlonly. Never hardcode user-visible strings into layouts, HTML, or JS. - Adding a language (all three, in the same commit):
- new language block in
_data/translations.ymlwith the same key set asen, - new
<lang>/index.mdwithlayout: landing+lang: <code>, link rel="alternate" hreflangentry in_layouts/default.html. Optionally add the code tosupportedLangsinassets/js/main.jsif browser auto-redirect should include it.
- new language block in
- New screenshots: put the file into
assets/sceenshots/and add an<img class="spawnable" ...>entry in the visuals section of_layouts/landing.htmlwith a meaningfulalt(SEO). - New FAQ entry: append
faq_qN/faq_aNpairs in_data/translations.yml; the FAQ loop renders whilefaq_q1..14exist — for more than 14 questions, extend the loop range in_layouts/landing.html. - Never:
- rename
assets/sceenshots/or changeCNAME,indexnow_key.txt,sw.jsstructure without a clear reason; - change the
url:/baseurl:in_config.yml(breaks hreflang, sitemap, PWA start URL); - remove
spawnableclasses or the spawn/reveal logic inassets/js/main.js(reviewed animation behavior: blocks spawn in document order at 10% visibility, staggered — see comments inmain.js); - introduce Python code, npm tooling, or any runtime besides the Jekyll + vanilla JS/HTML/CSS stack.
- rename
4. Testing process (smoke tests)
There is no test framework in this repo. The smoke gate for every change is a clean strict build plus a diff sanity check:
# 1. Install dependencies (Ruby)
gem install bundler
bundle install
# 2. Strict build — must finish with "Jekyll is not running" / no errors
bundle exec jekyll build --strict
# 3. Verify expected outputs exist in _site/
test -f _site/index.html
for l in be de el es fr hi it jp pl ru sr ua zh; do
test -f "_site/$l/index.html"
done
grep -q "CACHE_NAME = 'ecliptica-v" _site/sw.js
grep -q "ecliptica.me" _site/CNAME
# 4. If you touched precached assets (/assets/css/style.css, /assets/js/main.js,
# /assets/images/ecliptica_main_banner.png or the root page), confirm
# sw.js CACHE_NAME was bumped in the same commit.
# 5. Diff check before pushing
git --no-pager diff main...task_<issue-number> --stat
Local visual check (optional but recommended for layout/animation changes):
bundle exec jekyll serve # open http://127.0.0.1:4000 and /ru/
5. Delivery checklist (per task)
- branch
task_XXXfrom up-to-datemain bundle exec jekyll build --strictpasses- all 14 language pages build into
_site/<lang>/index.html - PWA cache name bumped if a precached asset changed
git diffreviewed (Markdown-friendly, no typos)- push branch, open PR against
main - issue labeled
waiting-for-review, checklist comment updated
6. Key links
- Steam: https://store.steampowered.com/app/3723390/Ecliptica/
- Discord: https://discord.gg/FRpw2565Sy
- Game repo: https://github.com/QuasarApp/Ecliptica (separate project — do not mix changes)