Unciv/Getting-Started.md at fbd6d36ad344006385c2eb03af446c0747a2b6f9

mirror of https://github.com/yairm210/Unciv.git synced 2025-01-10 23:37:31 +07:00

Move wiki pages into repository, fix dozens of broken links. (#5854 )

* Updated Mods (markdown)

* Updated Scenarios (markdown)

* Updated Mods (markdown)

* Added itch.io release

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Project structure and major classes (markdown)

* Updated Mods (markdown)

* Created Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Added link to Uniques

* Updated Uniques (markdown)

* Added 'triggers victory' unique

* Updated Making a new Civilization (markdown)

* Created Building locally without Android Studio (markdown)

* Updated Translating (markdown)

* Updated Uniques (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Uniques (markdown)

* Added improvement uniques

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Mods (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* I thought a tutorial on how to create a custom tileset in the first place could not hurt

* Moved the sentence to the "Creating a custom tileset" page

* Updated Making a new Civilization (markdown)

* Updated Mods Making a new Civilization (markdown)

* Updated Mods Making a new Civilization (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Destroyed Scenarios (markdown)

* Updated Uniques (markdown)

* Changed Travis documentation to Github actions documentation

* Updated Translating (markdown)

* Updated Translating (markdown)

* Updated From code to deployment (markdown)

* Removed "working on templated rule variants" because we currently don't

* Updated Uniques (markdown)

* Updated uniques based on everything done during the policy update

* Misplaced a unique

* Updated Making a new Civilization (markdown)

* Updated Making a new Civilization (markdown)

* Updated Translating (markdown)

* Updated Uniques (markdown)

* Removed [pending] messages for PR's that were no longer pending

* Added uniques from telecommuncations/advanced balistics

* Added all the uniques from my PR's (telecommunicatoins -- shrines); added uniques I deprecated at some point

* Updated Uniques (markdown)

* Added missing deprecated unique

* Added uniques changed in #4292

* Updated Uniques (markdown)

* Added uniques from #4311 and #4301

* Added uniques from #4331

* Added Discord webhook message

* Created page with basic information

* Typo

* Made information not incorrect

* Added units.json

* Manual new lines was a terrible idea

* Updated JSON files for mods (markdown)

* Added link to JSON files for mods explanation

* Added eras.json

* capitalization

* Added a header

* Improved example

* Added Buildings.json

* hmmm

* Doesn't work, sad

* Added information on Specialists.json

* Updated JSON files for mods (markdown)

* Added uniques from #4372

* Updated Uniques (markdown)

* Updated uniques after #4393

* Updated uniques after #4423

* Add new and deprecated uniques of #4487, #4459

* add wonder images

* Fixed mod directory

* Updated Uniques (markdown)

* Updated uniques after #4530, #4505, #4419

* Reworked the passages on tileFilter, terrainFilter and improvementFilter from code inspection

* Added a more indept guide on how to install UnCiv on macOS

* Updated Uniques (markdown)

* Created Credits.md (markdown)

* Destroyed Credits.md (markdown)

* Added installing from source method

* Improve Sound chapter, added Civilopedia text chapter

* Added after #4619

* Added unitTypes.json

* Added beliefs.json

* Updated Translating (markdown)

* Added eras:unitBaseBuyCost

* Added after #4568

* Added ruins.json

* Added after #4771

* Added rudimentary Difficulties.json doc

* Added ruin-specfic uniques explanation

* Added TOC and Nations

* Detailed Techs chapter

* Fix 1 line - tech uniques

* Added Quests.json

* Added ModOptions

* Added ModOptions

* Added UnitPromotions, structured TOC

* Added Policies

* Added crosslinks

* Fixed broken links

* Added TileResources

* Added more crosslinks

* Small fix resource tile graphix aren't toggle-able

* Added TileImprovements

* Added Terrains

* Updated JSON files for mods (markdown)

* Updated Getting Started (markdown)

* Updated Getting Started (markdown)

* Updated Getting Started (markdown)

* Updated JSON files for mods (markdown)

* Updated Translating (markdown)

* Created Civilization-related JSON files (markdown)

* Created Map-related JSON files (markdown)

* Double title

* Double title

* Created Unit-related JSON files (markdown)

* Moved sounds

* Updated Unit related JSON files (markdown)

* Moved Stats

* Created Miscellaneous JSON files (markdown)

* Removed content that has been moved to separate pages, update TOC

* Created _Sidebar (markdown)

* Updated Uniques (markdown)

* test

* Fixed broken links. Apparently the way 'preview' links to pages differs from how it links when you view them on a saved page for some reason

* Updated Uniques (markdown)

* Fix relative `..` link suddenly leaving the wiki

* Updated Miscellaneous JSON files (markdown)

* Fix relative links

* Fix era links to Units.json

* Updated Uniques (markdown)

* Updated From code to deployment (markdown)

* Added uniques & cityFilters up to #4995

* Mass deprecation as per 422607

* Fixed broken link to redirect to Unit Uniques in Wiki

* Fixed broken link to redirect to Unit Uniques in Wiki table

* Updated Uniques (markdown)

* Updated Getting Started (markdown)

* Updated Uniques (markdown)

* Added uniques & filters up to #5094

* Removed a deprecated unique

* Moved some uniques to better sections, removed an outdated unique

* fixed a typo

* Updated Uniques (markdown)

* eras.json is now required

* Removed outdated religion section

* Added missing terrain uniques

* Added resource uniques

* Fixed resource unique link

* Added missing unique for tile improvements

* Fixed broken link

* "Disappearing" translations explained

* Updated Home (markdown)

* Some atlas info, leader portraits

* Created Force rating calculation (markdown)

* "Not yet" for Image atlas distribution in mods

* Updated uniques after #5259

* Added information on conditionals

* Updated growth unique

* Added conditional support up to #5270

* Typo

* Escape html tags

* Add conditionals to table of contents

* Updated _Sidebar (markdown)

* Created Audiovisual Mods (markdown)

* Audiovisual Mods, move Graphics-only info

* Updated Audiovisual Mods (markdown)

* Audiovisual Mods - Draft done.

* Documented translation method

* Updated Translations, mods, and modding freedom in Open Source (markdown)

* Fix Typos and Links

* New Terrain uniques / 2 sections

* Atlas control via multiple Images.x folders is now live

* Link to atlas paragraph

* startBias clarification

* Missing bracket

* Added uniques & conditionals up to #5345 (my PR's only)

* Updated Force rating calculation (markdown)

* Updated Getting Started (markdown => asciidoc)

* Undid renaming

* Updated Getting Started (asciidoc => markdown)

* Added fix for Gradle sync fail

* Updated Project structure and major classes (markdown)

* Bump Java version from JDK 8 to JDK 11 due to gradle upgrade

* Updated uniques & conditionals up to #5618 from my PR's

* Created Regions (markdown)

* Updated Uniques (markdown)

* Updated Uniques (markdown)

* Mention docs/uniques.md, emphasized Stat capitalization

* Move wiki files into `/docs/wiki`.

* Migrate inter-Markdown links.

* Fix pre-existing broken links and anchors.

* Standardize repository links for AS linting.

* Add wiki footer.

* Updated Uniques (markdown)

* Updated Mods Making a new Civilization (markdown)

* Updated Making a new Civilization (markdown)

* Add GH Action for updating wiki.

* Play it safer, and don't `push -f`. (Should be the same either way though.)

Co-authored-by: Yair Morgenstern <yairm210@hotmail.com>
Co-authored-by: GGGuenni <leonard@eynck.de>
Co-authored-by: Xander Lenstra <71121390+xlenstra@users.noreply.github.com>
Co-authored-by: Martin Pechstein <77325495+Mape6@users.noreply.github.com>
Co-authored-by: Arthur van der Staaij <32672293+avdstaaij@users.noreply.github.com>
Co-authored-by: SimonCeder <63475501+SimonCeder@users.noreply.github.com>
Co-authored-by: SomeTroglodyte <63000004+SomeTroglodyte@users.noreply.github.com>
Co-authored-by: Alex25820 <50142558+Alex25820@users.noreply.github.com>
Co-authored-by: jvy1001 <76390095+jvy1001@users.noreply.github.com>
Co-authored-by: Shann Aurelle Ripalda <shannaurelleg@gmail.com>
Co-authored-by: NxOne14 <81563289+NxOne14@users.noreply.github.com>
Co-authored-by: MenaKing2020 <92416577+MenaKing2020@users.noreply.github.com>
Co-authored-by: asda488 <39116917+asda488@users.noreply.github.com>

2022-01-23 21:49:43 +02:00

2.3 KiB

Raw Blame History

This is a guide to editing, building, running and deploying Unciv from code

So first things first - the initial "No assumptions" setup to have Unciv run from-code on your computer!

Install Android Studio - it's free and awesome! Be aware that it's a long download!
Install Git, it's the way for us to work together on this project. UI is optional, Android Studio has good Git tools built in :)
Getting the code
- Create a Github account, if you don't already have one
- Fork the repo (click the "Fork" button on the top-right corner of https://github.com/yairm210/Unciv) - this will create a "copy" of the code on your account, at https://github.com/YourUsername/Unciv
- Clone your fork with git - the location will be https://github.com/YourUsername/Unciv.git, visible from the green "Clone or download" button at https://github.com/YourUsername/Unciv
Load the project in Android Studio, Gradle will attempt the initial sync. If this is your first time with Android Studio, this may require you to accept the Android Build-tools licenses, which works differently on every device, so search for your OS-specific solution.
- A new install may not be able to do the initial sync. If you have this problem go into File > Settings > Appearance & Behavior > System Settings > Android SDK
  - Click "SDK Tools"
  - Select "Show Package Details" in the bottom right
  - Choose version 30.0.2 under "Android SDK Build-Tools 31"
  - Click "Apply"
In Android Studio, Run > Edit configurations.
- Click "+" to add a new configuration
- Choose "Application"
- Set the module to Unciv.desktop, main class to com.unciv.app.desktop.DesktopLauncher and <repo_folder>\android\assets\ as the Working directory, OK to close the window
Select the Desktop configuration and click the green arrow button to run!

Unciv uses Gradle to specify dependencies and how to run. In the background, the Gradle gnomes will be off fetching the packages (a one-time effort) and, once that's done, will build the project!

Congratulations! Unciv should now be running on your computer! Now we can start changing some code, and later we'll see how your changes make it into the main repository!

Now would be a good time to get to know the project in general at the Project Structure overview!

2.3 KiB Raw Blame History

2.3 KiB

Raw Blame History