{"id":29905851,"url":"https://github.com/allureofthestars/allure","last_synced_at":"2025-08-01T20:02:43.497Z","repository":{"id":391097,"uuid":"956494","full_name":"AllureOfTheStars/Allure","owner":"AllureOfTheStars","description":"Allure of the Stars is a near-future Sci-Fi roguelike and tactical squad combat game written in Haskell; please offer feedback, e.g., after trying out the web frontend version at","archived":false,"fork":false,"pushed_at":"2023-11-17T13:43:38.000Z","size":11839,"stargazers_count":222,"open_issues_count":27,"forks_count":18,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-08-01T01:07:22.351Z","etag":null,"topics":["ascii","browsergame","freesoftware","game","haskell","html5","lambdahack","pcg","replayability","roguelike","sdl","squad","tactical","turnbased"],"latest_commit_sha":null,"homepage":"http://allureofthestars.com","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AllureOfTheStars.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2010-10-02T13:22:20.000Z","updated_at":"2025-06-12T03:08:35.000Z","dependencies_parsed_at":"2023-11-17T14:59:29.063Z","dependency_job_id":null,"html_url":"https://github.com/AllureOfTheStars/Allure","commit_stats":{"total_commits":4015,"total_committers":11,"mean_commits":365.0,"dds":0.07148194271481945,"last_synced_commit":"7c6a2d68fb1c6d7318671d2863daf7d6a8ef9bf2"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"purl":"pkg:github/AllureOfTheStars/Allure","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllureOfTheStars%2FAllure","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllureOfTheStars%2FAllure/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllureOfTheStars%2FAllure/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllureOfTheStars%2FAllure/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AllureOfTheStars","download_url":"https://codeload.github.com/AllureOfTheStars/Allure/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllureOfTheStars%2FAllure/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268162159,"owners_count":24205690,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii","browsergame","freesoftware","game","haskell","html5","lambdahack","pcg","replayability","roguelike","sdl","squad","tactical","turnbased"],"created_at":"2025-08-01T20:01:29.175Z","updated_at":"2025-08-01T20:02:38.725Z","avatar_url":"https://github.com/AllureOfTheStars.png","language":"Haskell","readme":"Allure of the Stars\n===================\n\n[![Hackage](https://img.shields.io/hackage/v/Allure.svg)](https://hackage.haskell.org/package/Allure)\n[![Join the chat at Discord](https://img.shields.io/discord/688792755564052486.svg?label=chat%20on%20Discord\u0026logo=discord\u0026logoColor=ffffff\u0026color=7389D8\u0026labelColor=6A7EC2)](https://discord.gg/87Ghnws)\n[![Join the chat at Matrix](https://img.shields.io/matrix/lambdahack:mozilla.org.svg?label=chat%20on%20Matrix\u0026logo=matrix\u0026server_fqdn=mozilla.modular.im)](https://matrix.to/#/#lambdahack:mozilla.org)\n\nAllure of the Stars is a near-future Sci-Fi roguelike[2]\nand tactical squad combat game. Binaries and the game manual\nare available at the homepage[6]. You can also try the game out\nin the browser at http://allureofthestars.com/play.\n\n![gameplay screenshot](https://raw.githubusercontent.com/AllureOfTheStars/media/master/screenshot/allureofthestars.com.second.attempt.gif)\n\nNot a single image in this game. You have to imagine everything\nyourself, like with a book (a grown-up book, without pictures).\nOnce you learn to imagine things, though, you can keep exploring\nand mastering the world and making up stories for a long time.\n\nThe game is written in Haskell[1] using the LambdaHack[10] roguelike\ngame engine.\nPlease see the changelog file for recent improvements\nand the issue tracker for short-term plans. Long term goals\nare high replayability and auto-balancing through procedural\ncontent generation and persistent content modification\nbased on player behaviour. Contributions are welcome.\nPlease offer feedback to mikolaj.konarski@funktory.com or, preferably,\non any of the public forums.\n\n\nGame installation from binary archives\n--------------------------------------\n\nThe game runs rather slowly in the browser (fastest on Chrome) and you are\nlimited to the square font for all purposes, though it's scalable.\nAlso, savefiles are prone to corruption on the browser,\ne.g., when it's closed while the game is still saving progress\n(which takes a long time). Hence, after trying out the game,\nyou may prefer to use a native binary for your architecture, if it exists.\n\nPre-compiled game binaries are available through the release page[11]\n(and Linux dev versions from GitHub Actions[18] and Windows from AppVeyor[19]).\nTo use a pre-compiled binary archive, unpack it and run the executable\nin the unpacked directory or use program shortcuts from the installer,\nif available. On Linux, make sure you have the SDL2 libraries installed\non your system (e.g., libsdl2-2.0-0 and libsdl2-ttf-2.0-0 on Ubuntu).\nFor Windows (XP no longer supported), the SDL2 and all other needed libraries\nare included in the game's binary archive.\n\nMax OS X binaries for the few most popular OS versions are accessible\nfrom Homebrew via `brew install allureofthestars`,\nwhich also takes care of all dependencies.\n\n\nScreen and keyboard configuration\n---------------------------------\n\nThe game UI can be configured via a config file.\nThe default config settings, the same that are built into the binary,\nare on github at [GameDefinition/config.ui.default](https://github.com/AllureOfTheStars/Allure/blob/master/GameDefinition/config.ui.default).\nWhen the game is run for the first time, or whenever the config file\nis deleted, the file is written to the default user data location,\nwhich is `~/.Allure/` on Linux,\n`C:\\Users\\\u003cusername\u003e\\AppData\\Roaming\\Allure\\`\n(or `C:\\Documents And Settings\\user\\Application Data\\Allure\\`\nor something else altogether) on Windows\nand `Inspect/Application/Local Storage` under RMB menu\nwhen run inside the Chrome browser.\nIf the user config file is outdated or corrupted, it's automatically\nmoved away together with old savefiles. At the next game start,\nthe new default config file appears at its place.\n\nScreen fonts and, consequently, window size can be changed by editing\nthe config file in the user data folder. The default bitmap font\n`16x16xw.bdf` used for the game map covers most national characters\nin the Latin alphabet (e.g. to give custom names to player characters)\nand results in a game window of exactly 720p HD dimensions. The `8x8xb.fnt`\nbitmap font results in a tiny window and covers latin-1 characters only.\nThe config file parameter `allFontsScale` permits further window size\nadjustments, automatically switching to the scalable version of the large\ngame map font (`16x16xw.woff`). Config file option `chosenFontset` governs\nnot only the main game map font, but also the shape of the rectangular fonts,\nif any, in which longer texts are overlaid over the map.\n\nFor high resolution displays and/or if fullscreen mode is requested\nin the configuration file, `allFontsScale` needs to be set.\nE.g., scale 3 works for 4K displays. Otherwise, the letters may be\ntoo small or, in fullscreen or on retina displays in OS X,\nthe screen may be automatically scaled as a whole, not each letter\nseparately, softening letter edges of the square fonts that should\nrather be pixel-perfect and crisp.\n\nIf you don't have a numeric keypad, you can use the left-hand movement\nkey setup (axwdqezc) or Vi editor keys (aka roguelike keys) or mouse.\nIf numeric keypad doesn't work, toggling the Num Lock key sometimes helps.\nIf running with the Shift key and keypad keys doesn't work,\ntry the Control key instead. The game is fully playable with mouse only,\nas well as with keyboard only, but the most efficient combination\nmay be mouse for menus, go-to, inspecting the map, aiming at distant\npositions and keyboard for everything else.\n\nIf you run the ANSI terminal frontend (`--frontendANSI` on commandline),\nthen numeric keypad (especially keypad `*`, `/` and `5`) may not work\ncorrectly, depending on the terminal emulator you use. Toggling\nthe Num Lock key may help or make issues worse. As a work around\nthese issues, numbers are used for movement in the ANSI frontend,\nwhich sadly prevents the number keys from selecting heroes.\nThe commands that require pressing Control and Shift together won't work\neither, but fortunately they are not crucial to gameplay.\n\nSome effort went into making the ANSI frontend usable with screen readers,\nbut without feedback it's hard to say how accessible that setup is.\nThis doesn't work on Windows, due to extra code that would be required.\nAs a side effect of screen reader support, there is no aiming line\nnor path in ANSI frontend and some of map position highlighting\nis performed using the terminal cursor. Screen readers may also work\nbetter with animations turned off, using `--noAnim` or the corresponding\nconfig file or main game menu options.\n\n\nCompiling native binary from source\n-----------------------------------\n\nTo compile with the standard frontend based on SDL2, you need the SDL2\nlibraries for your OS. On Linux, remember to install the -dev versions\nas well, e.g., libsdl2-dev and libsdl2-ttf-dev on Ubuntu Linux 16.04.\nCompilation to JavaScript for the browser is more complicated\nand requires the ghcjs[15] compiler and optionally the Google Closure\nCompiler[16].\n\nThe latest official version of the game can be downloaded,\ncompiled for SDL2 and installed automatically using the 'cabal' tool,\nwhich may already be a part of your OS distribution, but if it's too old\n(version 3.4 or later is required) you can download the whole current\ncompilation suite as described at https://www.haskell.org/downloads/.\nYou can get and run the Allure of the Stars package from Hackage[3] as follows\n\n    cabal update\n    cabal install Allure\n    ~/.cabal/bin/Allure\n\nFor a newer, unofficial version, clone the game source from github[5],\nclone a matching LambdaHack library snapshot into ../LambdaHack and run\n\n    cabal run --project-file=cabal.project.LH.dir\n\nAlternatively, if you'd like to develop in this codebase,\nthe following speeds up the turn-around a lot\n\n    cp cabal.project.local.development cabal.project.local\n\nand then you can compile (and recompile) with\n\n    cabal build\n\nand run the game with\n\n    make play\n\nThe SDL2 frontend binary also contains the ANSI terminal frontend\n(`--frontendANSI` on commandline) intended for screen readers\nand a simplified black and white line terminal frontend (`--frontendTeletype`)\nsuitable for teletype terminals or a keyboard and a printer (but it's going\nto use a lot of paper, unless you disable animations with `--noAnim`).\nThe teletype frontend is used in CI and for some tests and benchmarks defined\nin Makefile. The terminal frontends leave you on your own regarding font\nchoice and color setup and you won't have the colorful squares outlining\nspecial positions that exist in the SDL2 frontend, but only crude\ncursor highlights. The terminal frontends should run on Windows,\nbut Windows disables console for GUI applications, so they don't.\n\n\nTesting and debugging\n---------------------\n\nIntegration tests can be run and displayed with\n\n    cabal test --test-show-details=direct\n\nThe [Makefile](https://github.com/AllureOfTheStars/Allure/blob/master/Makefile)\ncontains many sample automated play test commands.\nNumerous tests that use the screensaver game modes (AI vs. AI)\nand the teletype frontend are gathered in `make test-locally`.\nSome of these are run by CI  on each push to github.\nTest commands with prefix `frontend` start AI vs. AI games with\nthe standard SDL2 frontend to view them on.\n\nRun `Allure --help` to see a brief description of all debug options.\nOf these, the `--sniff` option is very useful (though verbose\nand initially cryptic), for displaying the traffic between clients\nand the server. Some options in the config file may prove useful\nfor debugging too, though they mostly overlap with commandline options\n(and will be totally merged at some point).\n\n\n\nFurther information\n-------------------\n\nFor more information, visit the wiki[4]\nand see [PLAYING.md](https://github.com/AllureOfTheStars/Allure/blob/master/GameDefinition/PLAYING.md),\n[CREDITS](https://github.com/AllureOfTheStars/Allure/blob/master/CREDITS)\nand [COPYLEFT](https://github.com/AllureOfTheStars/Allure/blob/master/COPYLEFT).\n\nFor developer-focused information (coding style, overview of the codebase),\nplease see the README of LambdaHack[10].\n\nHave fun!\n\n\nCopyright\n---------\n\nCopyright (c) 2008--2011 Andres Loeh\n\nCopyright (c) 2010--2021 Mikolaj Konarski and others (see git history)\n\nAllure of the Stars is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program in file LICENSE.\nIf not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\nExceptions and detailed copyright information is contained in file COPYLEFT.\n\n\n[1]: https://www.haskell.org/\n[2]: http://roguebasin.roguelikedevelopment.org/index.php?title=Berlin_Interpretation\n[3]: https://hackage.haskell.org/package/Allure\n[4]: https://github.com/AllureOfTheStars/Allure/wiki\n[5]: https://github.com/AllureOfTheStars/Allure\n[6]: http://allureofthestars.com\n[10]: https://github.com/LambdaHack/LambdaHack\n[11]: https://github.com/AllureOfTheStars/Allure/releases\n[15]: https://github.com/ghcjs/ghcjs\n[16]: https://www.npmjs.com/package/google-closure-compiler\n[18]: https://github.com/AllureOfTheStars/Allure/actions\n[19]: https://ci.appveyor.com/project/Mikolaj/allure/build/artifacts\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallureofthestars%2Fallure","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallureofthestars%2Fallure","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallureofthestars%2Fallure/lists"}