Difference between revisions of "Useful Links"
Jump to navigation
Jump to search
Duckymirror (talk | contribs) m (Changed building planner link to admon's updated building planner) |
(Adding more Starter Kit links) |
||
(10 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Stubs]] |
[[Category:Stubs]] |
||
− | {{Stub}} |
||
− | |||
These online resources are very valuable, especially to new players. |
These online resources are very valuable, especially to new players. |
||
+ | == Discord == |
||
− | == [//screeps.slack.com Slack] == |
||
+ | |||
− | On our Slack channel, you can chat with other players and get technical help and advice on game strategy. |
||
+ | * [https://discord.gg/Z7XzJUw7PE Join the Screeps Discord] - Find official announcements, seasons, events, technical support, and discussions within the active Screeps player community. |
||
+ | |||
+ | == Documentation == |
||
+ | |||
+ | === Screeps World === |
||
+ | * [https://docs.screeps.com/api/ Screeps API] - Reference manual describing game objects, methods and prototypes. |
||
+ | * [https://docs.screeps.com/ Screeps Docs] - Documentation for game mechanics, gameplay, configuration, and other topics. |
||
+ | *[https://lodash.com/docs/3.10.1 Lodash v3.10.1] - Documentation for the Lodash version available in Screeps. |
||
+ | *[[Great Filters]] - Reference that describes development approaches in Screeps. |
||
+ | |||
+ | === Screeps Arena === |
||
+ | |||
+ | * [https://arena.screeps.com/docs/ Screeps Arena API] - Reference manual for Screeps Arena describing game objects and functions. |
||
+ | |||
+ | == Screeps on YouTube == |
||
+ | |||
+ | * [https://www.youtube.com/@screeps3952/videos Screeps Official] - From the Screeps dev team, Attack Rank videos and Featured content. |
||
+ | * [https://www.youtube.com/watch?v=edBMmOAfJ-Q&list=PL0EZQ169YGlor5rzeJEYYPE3tGYT2zGT2 th_pion] - Screeps nooby guide series. |
||
+ | |||
+ | * [https://www.youtube.com/watch?v=N7KMOG8C5vA&list=PLw9di5JwI6p-HUP0yPUxciaEjrsFb2kR2 Atanner Gaming] - Screeps tutorial series. |
||
+ | |||
+ | * [https://www.youtube.com/watch?v=dWP3VRKmV4Q&list=PL1m2M8LQlzfKndesWcReHzj9-zq1qP2CG Learn Code By Gaming] - Screeps tutorial walkthrough for beginners. |
||
+ | |||
+ | * [https://www.youtube.com/watch?v=OhBLmkiTZe4&list=PLCRhjmqETCePxmtB2mKScrJB_SCAI6jqw KarateSnoopy] - Let's Play Screeps series. |
||
+ | |||
+ | * [https://www.youtube.com/@MarvinTMB/playlists Marvin] - Screeps tutorials, event coverage, and Screeps analysis videos. |
||
+ | * [https://www.youtube.com/@V1kingScreeps/videos V1kingScreeps] - Screeps analysis and speedrun videos. |
||
+ | |||
+ | == League of Automated Nations == |
||
+ | LOAN for short. This site provides an alliance registry, alliance maps, player rankings and more. |
||
+ | |||
+ | * Visit the website: [http://www.leagueofautomatednations.com/ League of Automated Nations] |
||
+ | * [https://github.com/LeagueOfAutomatedNations LOAN GitHub] for a browser extension and other projects. |
||
+ | |||
+ | == Private Server Launchers == |
||
+ | |||
+ | === Custom Launchers === |
||
+ | These are the community preferred solutions for hosting a private server. |
||
+ | |||
+ | * [https://github.com/Jomik/screeps-server Jomik: Screeps Server] - Easy to use, Docker-based. |
||
+ | * [https://github.com/screepers/screeps-launcher Screeps Launcher] - Supports both Docker and direct setups. |
||
+ | |||
+ | === Official Launcher === |
||
+ | |||
+ | * '''GUI Launcher''': This launcher comes with the standard version of Screeps World on Steam. It provides a GUI for managing the server, viewing server logs, and a CLI interface to control the server. |
||
+ | |||
+ | * '''Console Launcher''': Allows launching the server from a command line without the GUI. Prerequisites include Node 10, Python 2, and developer build tools |
||
+ | |||
+ | == Screeps Clients == |
||
+ | Steamless client runs your copy of Screeps in the browser and works with private servers on macOS, Linux and Windows. |
||
+ | |||
+ | * [https://github.com/screepers/steamless-client screepers-steamless-client] - Screepers version is updated with additional features. |
||
+ | |||
+ | * [https://github.com/laverdet/screeps-steamless-client screeps-steamless-client] - Original Screeps steamless client. |
||
+ | * [https://github.com/laverdet/xxscreeps xxscreeps] - Optimized rewrite of the Screeps client. |
||
+ | * [https://github.com/thmsndk/Screeps3D Screeps3D] - 3D client for Screeps. |
||
+ | |||
+ | == Screeps Mods == |
||
+ | These mods are commonly installed on Screeps Private Servers. |
||
+ | |||
+ | * [https://github.com/screepsmods/screepsmod-mongo screepsmod-mongo] - Recommended - Private servers run much better with MongoDB compared to the default LokiJS db. |
||
+ | * [https://github.com/ScreepsMods/screepsmod-auth screepsmod-auth] - Recommended - Adds basic auth and allows players to upload scripts via API |
||
+ | * [https://github.com/ScreepsMods/screepsmod-admin-utils screepsmod-admin-utils] - Useful commands for server admins. |
||
+ | * [https://github.com/ScreepsMods/screepsmod-market screepsmod-market] |
||
+ | * [https://github.com/ScreepsMods/screepsmod-history screepsmod-history] - ''Warning: may corrupt server after 1M ticks.'' |
||
+ | * [https://github.com/admon84/screepsmod-speedrun screepsmod-speedrun] - Removes bots and disables invaders for a speedrun. |
||
+ | * [https://github.com/orgs/ScreepsMods/repositories ScreepsMods] |
||
+ | |||
+ | == Code Profilers == |
||
+ | |||
+ | * [https://github.com/gdborton/screeps-profiler gdborton: Screeps Profiler] - JavaScript |
||
+ | * [https://github.com/screepers/screeps-typescript-profiler Screepers: Screeps TypeScript Profiler] - TypeScript |
||
+ | * [https://github.com/snorrwe/screeps-profiler snorrwe: screeps-profiler] - Rust |
||
+ | * [https://github.com/benjamingorman/banan benjamingorman: banan] - Flame graph |
||
+ | |||
+ | == Grafana == |
||
+ | |||
+ | * [https://github.com/screepers/ScreepsGrafanaV2 Screepers: ScreepsGrafanaV2] - Self-host Grafana service for your Screeps bot. |
||
+ | |||
+ | == Building Planners == |
||
+ | |||
+ | * [https://screepers.github.io/screeps-tools/#/building-planner Screepers: Screeps Tools Building Planner] - The most feature rich building planner + creep stats calculator. |
||
+ | * [https://admon84.github.io/screeps-tools/#/building-planner admon84: Screeps Tools Building Planner (1.0)] + creep stats calculator. |
||
+ | * [https://screeps-room-planner.vercel.app/ admon84: Screeps Room Planner (2.0)] |
||
+ | * [https://github.com/Arcath/screeps-tools Arcath: Screeps Tools] + creep stats calculator. |
||
+ | |||
+ | == Creep Body Calculators == |
||
+ | |||
+ | * [https://codepen.io/o4kapuk/full/ZKeorE o4kapuk: Creep body calculator] - The most trustworthy source for calculating creep stats. |
||
+ | * [http://codepen.io/PhillipK/full/wzLaWJ PhillipK: Creep body calculator] - Another version that appears to be based on o4's. |
||
+ | |||
+ | == Power Creep Planner == |
||
+ | |||
+ | * [https://www.devhax.eu/power-planner Orlet: Power Creep Planner] |
||
+ | |||
+ | == Open Source Libraries == |
||
+ | |||
+ | * [https://github.com/screepers/RoomVisual Screepers: RoomVisual] - A library for visualizing structure placements into your Screeps bot. |
||
+ | * [https://github.com/screepers/Traveler Screepers: Traveler] - Updated version of Travler. |
||
+ | * [https://github.com/bonzaiferroni/Traveler bonzai: Traveler] - Wiki pages with additional notes about Traveler. |
||
+ | * [https://github.com/glitchassassin/screeps-cartographer glitchassassin: screeps-cartographer] - Advanced movement library for Screeps. |
||
+ | * [https://github.com/sy-harabi/Screeps-Traffic-Manager sy-harabi: Screeps Traffic Manager] - Traffic management library for Screeps. |
||
+ | |||
+ | == Other Useful Scripts == |
||
+ | |||
+ | * [https://github.com/screepers/screeps-snippets Screepers: screeps-snippets] - Interesting code snippets for posterity. |
||
+ | * [https://github.com/screepers/simpleAllies Screepers: simpleAllies] - An allies communication script commonly used in alliance-based events like Screeps Warfare Championship (SWC). |
||
+ | * [https://github.com/orgs/screepers/repositories Screepers] - Featuring community-made open source projects for Screeps. |
||
+ | |||
+ | == Screeps API == |
||
+ | |||
+ | * [https://github.com/screepers/python-screeps/blob/master/docs/Endpoints.md Screeps API Endpoints] - Unofficial documentation describing the Screeps API endpoints. |
||
+ | |||
+ | * [https://github.com/screepers/node-screeps-api Screepers: node-screeps-api] - A library for Node.js scripts |
||
+ | |||
+ | * [https://github.com/screepers/python-screeps Screepers: python-screeps] - A library for Python scripts |
||
+ | |||
+ | == TypeScript Types == |
||
+ | |||
+ | * [https://github.com/screepers/typed-screeps Screepers: typed-screeps] - Screeps World |
||
+ | |||
+ | * [https://github.com/screepers/typed-screeps-arena Screepers: typed-screeps-arena] - Screeps Arena |
||
+ | |||
+ | == Starter Kits == |
||
+ | |||
+ | === Screeps World === |
||
+ | |||
+ | * [https://github.com/screepers/screeps-typescript-starter Screepers: Screeps TypeScript Starter] - TypeScript |
||
+ | |||
+ | * [https://github.com/eduter/screeps-typescript-jest-starter eduter: Screeps TypeScript Jest Starter] - TypeScript |
||
+ | * [https://github.com/admon84/screeps-autonomous-framework admon84: Screeps Autonomous Framework] - TypeScript |
||
+ | * [https://github.com/rustyscreeps/screeps-starter-rust rustyscreeps: Screeps Starter Rust] - Rust |
||
− | == [https://docs.screeps.com/api/ API Docs] == |
||
+ | *[https://github.com/DroidFreak36/screeps_starter_python DroidFreak: Screeps Starter Python] - Python |
||
− | The documentation is a valuable reference. |
||
+ | *[https://github.com/exaV/screeps-kotlin-starter exaV: Screeps Kotlin Starter] - Kotlin |
||
+ | *[https://github.com/thomasfn/ScreepsDotNet/tree/main/ScreepsDotNet.ExampleWorldBot thomasfn: ScreepsDotNet Example World Bot] - C# |
||
+ | === Screeps Arena === |
||
− | == [http://www.leagueofautomatednations.com/map LOAN Alliance Tracking Site] == |
||
− | On the loan site you can view a map of all registered [[alliances]] and much more. Check their [https://github.com/LeagueOfAutomatedNations GitHub] for a browser extension and other projects. |
||
+ | * [https://github.com/screepers/screeps-arena-javascript-starter Screepers: Screeps Arena JavaScript Starter] - JavaScript |
||
− | == [http://ScreepsPl.us ScreepsPlus Hosted Grafana and other tools] == |
||
− | ScreepsPlus offers hosted grafana setups plus other utilities such as a badge generator. |
||
− | + | * [https://github.com/screepers/screeps-arena-typescript-starter Screepers: Screeps Arena TypeScript Starter] - TypeScript |
|
+ | * [https://github.com/kounoike/screeps-arena-typescript-bun-starter kounoike: Screeps Arena TypeScript Bun Starter] - TypeScript |
||
− | Community projects including an interactive standalone console, various statistics trackers, and a variety of other tools. |
||
+ | * [https://github.com/rustyscreeps/screeps-arena-starter-rust rustyscreeps: Screeps Arena Starter Rust] - Rust |
||
− | == Other Useful Tools == |
||
+ | *[https://github.com/thomasfn/ScreepsDotNet/tree/main/ScreepsDotNet.ExampleArenaBot thomasfn: ScreepsDotNet Example Arena Bot] - C# |
||
− | [https://screeps.admon.dev/building-planner Building planner] |
||
+ | [[Category:Community]] |
||
− | [http://codepen.io/PhillipK/full/wzLaWJ Creep body calculator] |
Latest revision as of 15:42, 20 July 2024
These online resources are very valuable, especially to new players.
Discord[edit | edit source]
- Join the Screeps Discord - Find official announcements, seasons, events, technical support, and discussions within the active Screeps player community.
Documentation[edit | edit source]
Screeps World[edit | edit source]
- Screeps API - Reference manual describing game objects, methods and prototypes.
- Screeps Docs - Documentation for game mechanics, gameplay, configuration, and other topics.
- Lodash v3.10.1 - Documentation for the Lodash version available in Screeps.
- Great Filters - Reference that describes development approaches in Screeps.
Screeps Arena[edit | edit source]
- Screeps Arena API - Reference manual for Screeps Arena describing game objects and functions.
Screeps on YouTube[edit | edit source]
- Screeps Official - From the Screeps dev team, Attack Rank videos and Featured content.
- th_pion - Screeps nooby guide series.
- Atanner Gaming - Screeps tutorial series.
- Learn Code By Gaming - Screeps tutorial walkthrough for beginners.
- KarateSnoopy - Let's Play Screeps series.
- Marvin - Screeps tutorials, event coverage, and Screeps analysis videos.
- V1kingScreeps - Screeps analysis and speedrun videos.
League of Automated Nations[edit | edit source]
LOAN for short. This site provides an alliance registry, alliance maps, player rankings and more.
- Visit the website: League of Automated Nations
- LOAN GitHub for a browser extension and other projects.
Private Server Launchers[edit | edit source]
Custom Launchers[edit | edit source]
These are the community preferred solutions for hosting a private server.
- Jomik: Screeps Server - Easy to use, Docker-based.
- Screeps Launcher - Supports both Docker and direct setups.
Official Launcher[edit | edit source]
- GUI Launcher: This launcher comes with the standard version of Screeps World on Steam. It provides a GUI for managing the server, viewing server logs, and a CLI interface to control the server.
- Console Launcher: Allows launching the server from a command line without the GUI. Prerequisites include Node 10, Python 2, and developer build tools
Screeps Clients[edit | edit source]
Steamless client runs your copy of Screeps in the browser and works with private servers on macOS, Linux and Windows.
- screepers-steamless-client - Screepers version is updated with additional features.
- screeps-steamless-client - Original Screeps steamless client.
- xxscreeps - Optimized rewrite of the Screeps client.
- Screeps3D - 3D client for Screeps.
Screeps Mods[edit | edit source]
These mods are commonly installed on Screeps Private Servers.
- screepsmod-mongo - Recommended - Private servers run much better with MongoDB compared to the default LokiJS db.
- screepsmod-auth - Recommended - Adds basic auth and allows players to upload scripts via API
- screepsmod-admin-utils - Useful commands for server admins.
- screepsmod-market
- screepsmod-history - Warning: may corrupt server after 1M ticks.
- screepsmod-speedrun - Removes bots and disables invaders for a speedrun.
- ScreepsMods
Code Profilers[edit | edit source]
- gdborton: Screeps Profiler - JavaScript
- Screepers: Screeps TypeScript Profiler - TypeScript
- snorrwe: screeps-profiler - Rust
- benjamingorman: banan - Flame graph
Grafana[edit | edit source]
- Screepers: ScreepsGrafanaV2 - Self-host Grafana service for your Screeps bot.
Building Planners[edit | edit source]
- Screepers: Screeps Tools Building Planner - The most feature rich building planner + creep stats calculator.
- admon84: Screeps Tools Building Planner (1.0) + creep stats calculator.
- admon84: Screeps Room Planner (2.0)
- Arcath: Screeps Tools + creep stats calculator.
Creep Body Calculators[edit | edit source]
- o4kapuk: Creep body calculator - The most trustworthy source for calculating creep stats.
- PhillipK: Creep body calculator - Another version that appears to be based on o4's.
Power Creep Planner[edit | edit source]
Open Source Libraries[edit | edit source]
- Screepers: RoomVisual - A library for visualizing structure placements into your Screeps bot.
- Screepers: Traveler - Updated version of Travler.
- bonzai: Traveler - Wiki pages with additional notes about Traveler.
- glitchassassin: screeps-cartographer - Advanced movement library for Screeps.
- sy-harabi: Screeps Traffic Manager - Traffic management library for Screeps.
Other Useful Scripts[edit | edit source]
- Screepers: screeps-snippets - Interesting code snippets for posterity.
- Screepers: simpleAllies - An allies communication script commonly used in alliance-based events like Screeps Warfare Championship (SWC).
- Screepers - Featuring community-made open source projects for Screeps.
Screeps API[edit | edit source]
- Screeps API Endpoints - Unofficial documentation describing the Screeps API endpoints.
- Screepers: node-screeps-api - A library for Node.js scripts
- Screepers: python-screeps - A library for Python scripts
TypeScript Types[edit | edit source]
- Screepers: typed-screeps - Screeps World
- Screepers: typed-screeps-arena - Screeps Arena
Starter Kits[edit | edit source]
Screeps World[edit | edit source]
- Screepers: Screeps TypeScript Starter - TypeScript
- eduter: Screeps TypeScript Jest Starter - TypeScript
- admon84: Screeps Autonomous Framework - TypeScript
- rustyscreeps: Screeps Starter Rust - Rust
- DroidFreak: Screeps Starter Python - Python
- exaV: Screeps Kotlin Starter - Kotlin
- thomasfn: ScreepsDotNet Example World Bot - C#
Screeps Arena[edit | edit source]
- Screepers: Screeps Arena JavaScript Starter - JavaScript
- Screepers: Screeps Arena TypeScript Starter - TypeScript
- kounoike: Screeps Arena TypeScript Bun Starter - TypeScript