Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tutorials #12192

Merged
merged 123 commits into from
Sep 15, 2024
Merged

Update tutorials #12192

merged 123 commits into from
Sep 15, 2024

Conversation

EmperorPinguin
Copy link
Contributor

@EmperorPinguin EmperorPinguin commented Sep 8, 2024

Rephrases the controversial New Game tutorial, and adds a new one with deviations from Civ5.

@yairm210
Copy link
Owner

yairm210 commented Sep 8, 2024

Looks fine to me
I actually didn't know about those Civ V differences!

@SomeTroglodyte
Copy link
Collaborator

There's a "grwoth" in here. Sounds like a new D&D monster? Oh, same second 0e8b1d1 comes around. But in the same string, around "as they are born and the city focus" - there's a marked semantic separation meant after "born", right? Doesn't come across optimally.

@SomeTroglodyte
Copy link
Collaborator

If you start listing Civ5-UnC differences - wasn't there a collection of those around somewhere? Consider re-mentioning those?

"build aqueducts ... sell your shrine" ...huh? Not really understandable, and even replacing aqueduct for shrine I still don't get how C5 would have an exploitable glitch here.

"looking for and founding next to luxury resources" - while very well written this entire article ignores that the AI already chose an optimal place for you. The code behind that - at least when not playing a saved map - is quite extensive, so normally you'd want to settle wherever the starting location code placed your first Settler - unless that code is bad? Can we get a very short mention that the game already tries its best for you in most cases in there without disrupting the flow too much?

@Caballero-Arepa
Copy link
Contributor

@Caballero-Arepa

@EmperorPinguin
Copy link
Contributor Author

EmperorPinguin commented Sep 8, 2024

"looking for and founding next to luxury resources" - while very well written this entire article ignores that the AI already chose an optimal place for you. The code behind that - at least when not playing a saved map - is quite extensive, so normally you'd want to settle wherever the starting location code placed your first Settler - unless that code is bad? Can we get a very short mention that the game already tries its best for you in most cases in there without disrupting the flow too much?

Agree, this was written by the previous author, I didn't feel like changing it too much (it's mostly the scout vs warrior part that just didn't make sense). I'll try to rephrase the rest a bit according to your suggestions.

@EmperorPinguin
Copy link
Contributor Author

If you start listing Civ5-UnC differences - wasn't there a collection of those around somewhere? Consider re-mentioning those?

The page needs to be updated, to incorporate the change that melee ships can't capture civilians anymore.

@Caballero-Arepa
Copy link
Contributor

I like it a lot overall! I would switch to the civilopediaText format, and some minor corrections:

  • Luxuries aren't indicated by a smiley anymore
  • Cammel-case references to other game items
  • "More on that later!" imo is unnecessary, as it's explained in the same paragraph

Some questions:

  • ¿Is pointing out that cities have to be 3-tiles away to a new player necessary?
  • You can't disable religion in G&K, ¿is the note (when talking about the shrine) necessary?
This is my proposal for the format.

{
"name": "New Game",
"civilopediaText": [
{ "text": "Welcome to Unciv!\nBecause this is a complex game, there are basic tasks to help familiarize you with the game.\nThese are completely optional, and you're welcome to explore the game on your own!" },
{ "separator": true },
{ "text": "Your first mission is to found your capital city."},
{"text": "This is actually an important task because your capital city will probably be your most prosperous.\n Many game bonuses apply only to your capital city and it will probably be the center of your empire." },
{},
{ "text": "How do you know a spot is appropriate?\n Luckily, the game has already chosen a good location for you. You can settle in this place, or maybe move a turn to found on a Hill (for Production and defence) or next to a Mountain (to gain access to the Observatory building later on)." },
{},
{ "text": "You'll likely want more cities later on. For these cities, you must go and find a good place. Looking for and founding on or near Luxury resources is a good rule of thumb." },
{ "text": "Luxury resources are tiles that have things like Gems, Cotton, or Silk (indicated by a yellow background of the resource icon). These resources make your civilization happy. You should also keep an eye out for resources needed to build units, such as Iron. Cities cannot be built within 3 tiles of existing cities, which is another thing to watch out for!" },
{},
{ "text": "However, cities don’t have a set area that they can work. This means you don’t have to settle cities right on or next to resources.\n Let’s say, for example, that you want access to some Iron – but the resource is in a desert area. You don’t have to settle your city in the desert. You can settle a few tiles away in more prosperous lands. Your city will grow and eventually gain access to the resource. You only need to settle right on top of resources if you need them immediately." },
{},
{ "text": "The first thing coming out of your city depends on the strategy you want to follow, but the 'classic' build order is to build first two Scouts, the a Shrine, and three Settlers, and adopt Tradition, to explore the map quickly (Scouts ignore terrain cost), and to get an early Pantheon (if you're playing with religion enabled)." },
{"text": "But feel free to experiment with your own build orders!", "color": "#fa0"},
]
},

@Caballero-Arepa
Copy link
Contributor

@Caballero-Arepa, you were working on the tutorials as well, what do you think of this version?

Speaking of which, I was working on it at the same time xD

@EmperorPinguin
Copy link
Contributor Author

EmperorPinguin commented Sep 8, 2024

This is my proposal for the format.

I'm not entirely sold on the formatting, it should be more consistent in it use of space and newline, it's a bit annoying to read this way imo.

@EmperorPinguin
Copy link
Contributor Author

EmperorPinguin commented Sep 8, 2024

* ¿Is pointing out that cities have to be 3-tiles away to a new player necessary?

The question will come up in the Discord server when newbies aren't able to settle a city right next to capital, it should be explained better early than later. It's currently a bit too much of a wall of text though, some parts should be removed or shortened.

* You can't disable religion in G&K, ¿is the note (when talking about the shrine) necessary?

Idk, it makes the text more reuseable for Vanilla I think.

@Caballero-Arepa
Copy link
Contributor

Yeah, it could be improved.
image
In my opinion, newline should be used when the paragraph is getting too long.
After some changes:
image
(I know I made the header too small (initially set at 6), it's fixed now (set at 4)).
Removed the \n and replaced them with another "text", so all are consistent. I think those are better than the \n.
My reasoning is that if there is more space, like newlines and indentation, it is easier to read. But I'm still researching about it, because we need it to be easy to read.

The last paragraph should probably get a little header as well, instead of the double space, as it changes the topic (from city placement to build queue).

Details

{
  "name": "New Game",
  "civilopediaText": [
  { "text": "Welcome to Unciv!", "header":4},
  {"text": "Because this is a complex game, there are basic tasks to help familiarize you with the game."},
  {"text": "   These are completely optional, and you're welcome to explore the game on your own!" },
  { "separator": true },
  { "text": "Your first mission is to found your capital city. This is actually an important task because your capital city will probably be your most prosperous."},
  {"text": "   Many game bonuses apply only to your capital city and it will probably be the center of your empire." },
	  {},
  { "text": "How do you know a spot is appropriate?","header": 4},
  {"text": "Luckily, the game has already chosen a good location for you. You can settle in that place, or maybe move a turn to found on a Hill (for Production and defence) or next to a Mountain (to gain access to the Observatory building later on)." },
  {},
  { "text": "You'll likely want more cities later on. For these cities, you must go and find a good place - looking for and founding on or near Luxury resources is a good rule of thumb." },
  { "text": "   Luxury resources are tiles that have things like Gems, Cotton, or Silk (indicated by a yellow background of the resource icon). These resources make your civilization happy. You should also keep an eye out for resources needed to build units, such as Iron."},
  {"text": "   Cities cannot be built within 3 tiles of existing cities, which is another thing to watch out for!" },
  {},
  { "text": "However, cities don’t have a set area that they can work. This means you don’t have to settle cities right on or next to resources."},
  {"text": "   Let’s say, for example, that you want access to some Iron – but the resource is in a Desert area. You don’t have to settle your city in the Desert. You can settle a few tiles away in more prosperous lands. Your city will grow and eventually gain access to the resource."},
  {"text": "   You only need to settle right on top of resources if you need them immediately." },
	  {},
	  {},
  { "text": "The first thing coming out of your city depends on the strategy you want to follow, but the 'classic' build order is to first construct two Scouts, then a Shrine, and three Settlers, and adopting Tradition, to explore the map quickly (Scouts ignore terrain cost), and to get an early Pantheon (if you're playing with religion enabled)." },
  {"text": "   But feel free to experiment with your own build orders!", "color": "#fa0"}
   ]
},

@EmperorPinguin
Copy link
Contributor Author

EmperorPinguin commented Sep 8, 2024

(I know I made the header too small (initially set at 6), it's fixed now (set at 4)). Removed the \n and replaced them with another "text", so all are consistent. I think those are better than the \n. My reasoning is that if there is more space, like newlines and indentation, it is easier to read. But I'm still researching about it, because we need it to be easy to read.

The last paragraph should probably get a little header as well, instead of the double space, as it changes the topic (from city placement to build queue).
Details

Newline is cringe, I think you should avoid indentations, and instead divide the text in small paragraphs, each separated by a line of space.

@Caballero-Arepa
Copy link
Contributor

Caballero-Arepa commented Sep 8, 2024

Let's see
image
image

Details

{
  "name": "New Game",
  "civilopediaText": [
  { "text": "Welcome to Unciv!", "header":2},
  {"text": "Because this is a complex game, there are basic tasks to help familiarize you with the game."},
  {"text": "These are completely optional, and you're welcome to explore the game on your own!" },
  { "separator": true },
  { "text": "Your first mission is to found your capital city. This is actually an important task because your capital city will probably be your most prosperous."},
  {"text": "   Many game bonuses apply only to your capital city and it will probably be the center of your empire." },
	  {},
  { "text": "How do you know a spot is appropriate?","header": 4},
  {"text": "Luckily, the game has already chosen a good location for you. You can settle in that place, or maybe move a turn to found on a Hill (for Production and defence) or next to a Mountain (to gain access to the Observatory building later on)." },
  {},
  { "text": "You'll likely want more cities later on. For these cities, you must go and find a good place - looking for and founding on or near Luxury resources is a good rule of thumb." },
  {},
  { "text": "Luxury resources are tiles that have things like Gems, Cotton, or Silk (indicated by a yellow background of the resource icon). These resources make your civilization happy. You should also keep an eye out for resources needed to build units, such as Iron."},
  {},
  {"text": "Cities cannot be built within 3 tiles of existing cities, which is another thing to watch out for!" },
  {},
  { "text": "However, cities don’t have a set area that they can work. This means you don’t have to settle cities right on or next to resources."},
  {},
  {"text": "Let’s say, for example, that you want access to some Iron – but the resource is in a Desert area. You don’t have to settle your city in the Desert. You can settle a few tiles away in more prosperous lands. Your city will grow and eventually gain access to the resource."},
  {},
  {"text": "You only need to settle right on top of resources if you need them immediately." },
	  {},
  { "text": "What should I start building?", "header": 4},
  { "text": "The first thing coming out of your city depends on the strategy you want to follow, but the 'classic' build order is to first construct two Scouts, then a Shrine, and three Settlers, and adopting Tradition - to explore the map quickly (Scouts ignore terrain cost), and to get an early Pantheon (if you're playing with religion enabled)." },
  {},
  {"text": "But feel free to experiment with your own build orders!", "color": "#fa0"}
   ]
},

@EmperorPinguin
Copy link
Contributor Author

@Caballero-Arepa the game also needs a tutorial on the food conversion to production when construction Settler units. It's a question that keeps coming up, and it's apparently not in the civilopedia.

@yairm210 yairm210 merged commit 83dac35 into yairm210:master Sep 15, 2024
4 checks passed
Ouaz added a commit to Ouaz/Unciv that referenced this pull request Sep 15, 2024
Fix some missing brackets in yairm210#12192
@Ouaz Ouaz mentioned this pull request Sep 15, 2024
yairm210 pushed a commit that referenced this pull request Sep 15, 2024
Fix some missing brackets in #12192
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants