Clarify the game rules

[dmytroshytikov]

This file is a much better place for all this information.

[Mikolaj]

Thank you! Is the an alternative to https://github.com/AllureOfTheStars/Allure/pull/122 or an update version of the old PR? In the latter case, I guess it would have been easier for you to force-push (push -f) an amended commit (git commit -amend -a) to the old PR instead. But no harm done, of course.

[Mikolaj]

BTW, have a look at the CI -- it yelled at you. :D

[dmytroshytikov]

BTW, have a look at the CI -- it yelled at you. :D

So far, can't see. I will see if I can observe the issue again.

[Mikolaj]

I mean, the "Some checks were not successful" reports problems. I think they are about exceeding 80 characters.

[Mikolaj]

The "Some checks were not successful" is CI.

[Mikolaj]

"Continuous integration" -- compiling, checking and testing after each push.

[dmytroshytikov]

I mean, the "Some checks were not successful" reports problems. I think they are about exceeding 80 characters.

Yeah, I see. Well, I thought that as it is a text file (the markdown type), I can just type in the text I wanted, and the machine will automatically resize it as it should be. What should I do with it? And when I went to the file, I can see changes I suggested there.

[Mikolaj]

Markdown is a double purpose format. Some people view it formatted:

https://github.com/AllureOfTheStars/Allure/blob/b0c0ffad460100aadf4d5ba3271ec4f9b1c1f68f/GameDefinition/PLAYING.md

other view it raw, e.g, in the console with a cat or less command

https://raw.githubusercontent.com/AllureOfTheStars/Allure/b0c0ffad460100aadf4d5ba3271ec4f9b1c1f68f/GameDefinition/PLAYING.md

Additionally, the latter form is used in the game itself. The help screen ends with this file included (as captured at compilation time), in raw form, and the start menu displays the initial portion, slightly formatted.

I'm afraid, to keep the 80 columns, one needs to use an old fashioned text editor with monospace font and a ruler or window size set to 80 columns. Then commit the changes using a commandline git. Alternatively, perhaps Visual Studio can do that, but I'm not familiar with it.

[dmytroshytikov]

Markdown is a double purpose format. Some people view it formatted:

https://github.com/AllureOfTheStars/Allure/blob/b0c0ffad460100aadf4d5ba3271ec4f9b1c1f68f/GameDefinition/PLAYING.md

other view it raw, e.g, in the console with a cat or less command

https://raw.githubusercontent.com/AllureOfTheStars/Allure/b0c0ffad460100aadf4d5ba3271ec4f9b1c1f68f/GameDefinition/PLAYING.md

Additionally, the latter form is used in the game itself. The help screen ends with this file included (as captured at compilation time), in raw form, and the start menu displays the initial portion, slightly formatted.

I'm afraid, to keep the 80 columns, one needs to use an old fashioned text editor with monospace font and a ruler or window size set to 80 columns. Then commit the changes using a commandline git. Alternatively, perhaps Visual Studio can do that, but I'm not familiar with it.

So, do I need to resize my inserts? I can do that, I just thought it will be done automatically. But I can think how to rearrange it. It is an interesting coding task :) Do I understand correct that I need to make the text as 80 symbols per raw and with spaces before the first letter of each raw, right?

[Mikolaj]

So, do I need to resize my inserts? I can do that, I just thought it will be done automatically. But I can think how to rearrange it. It is an interesting coding task :)

I'm afraid that's necessary and I'm afraid it can't be done automatically (not perfectly at least and not without ML), because you don't want to split phrases that go together, such as "to " or "".

Do I understand correct that I need to make the text as 80 symbols per raw and with spaces before the first letter of each raw, right?

The special spaces are only needed for the first paragraphs, the ones that go into the starting menu. The rest just needs the rows to be below 80 character long and, say, above 55.

[dmytroshytikov]

I'm afraid that's necessary and I'm afraid it can't be done automatically (not perfectly at least and not without ML), because you don't want to split phrases that go together, such as "to " or "".

I'll see how to deal with this issue.

The special spaces are only needed for the first paragraphs, the ones that go into the starting menu. The rest just needs the rows to be below 80 character long and, say, above 55.

So, there is no need to have space in each raw, right? Just below 80 characters per raw, right?

[Mikolaj]

So, there is no need to have space in each raw, right? Just below 80 characters per raw, right?

Yes. But if in doubt, please look at the surrounding text. There are no leading spaces. Why do you expect them to be there? Is this the misleading github display? (BTW, it's "row".)

[dmytroshytikov]

So, there is no need to have space in each raw, right? Just below 80 characters per raw, right?

Yes. But if in doubt, please look at the surrounding text. There are no leading spaces. Why do you expect them to be there? Is this the misleading github display? (BTW, it's "row".)

Pardon me. The first part of the file has leading spaces. Ok, I'll rearrange.

[Mikolaj]

Let's see what CI says. ;)

[dmytroshytikov]

Interesting, why it takes so much time now.

[Mikolaj]

It probably doesn't fail at once, so probably it's fine now.

[dmytroshytikov]

What do these command lines do? Do they process this text file in different ways?

[Mikolaj]

Which lines, precisely?

[dmytroshytikov]

These checks

[Mikolaj]

To make sure we talk about the same thing: could you click on such a check you have in mind and copy here the link you followed and a fragment of the text you mean?

[dmytroshytikov]

I know it is a strange question :)

[Mikolaj]

The question is fine. It's just imprecise. I would never guess the "command lines" you mention are these CI job descriptions. Each line represents a single CI job that runs in the cloud. Did you try clicking on the link for any of the jobs? I think it would answer your question and it would not merge the PR, no worry. :) It says "Details", not "Merge".

[Mikolaj]

I have adjusted the style of the text according to the recommendations a little.

Thank you so much. Will review next week.

[dmytroshytikov]

Yay! Finished!

[Mikolaj]

Well done. Your new version of the manual is now the one shown by the main manual hyperlinks. Only the in-game manual is the old one until a new release is made (which may take a while).