Documentation improvements
-
Is there a thread to ask for clarifications on the documentation? With a programming game like this, I think the documentation is a very important part of the gameplay experience. I'd rather look something up in ten seconds then spend half an hour experimenting.
Couple of things to start: Creep.transfer: Do I get ERR_FULL if the target was 100% full at the start, so can receive zero, or if there was insufficient room to accommodate the whole 'amount'? If 'amount' is omitted, will the creep transfer 100% of carried resources or as much as it can allowing for capacity of target?
Right now it isn't clear to me how to easily check how much was/will be transferred. Even the capacity of the target is different for different targets.
Private servers There is precious little documentation on managing a private server. I think running a private server is pretty mainstream as a good development / test platform - it's not something a handful of specialists would do purely to set up alternative game environments. I could only really find https://wiki.screepspl.us/index.php/Private_Server_Common_Tasks and nothing on the official site.
StructureLab.boostCreep What do different compounds do? It's listed here: http://docs.screeps.com/minerals.html - would it hurt to copy the information so it's in the reference?
-
As far as I know, there is no thread for this kind of things on the forum. You can obtain help in Screeps slack (channel #help)
-
The documentation is open source now, so you can help make it better. As @o4kapuk mentioned too slack is really helpful for this.
-
@tedivm Looks like documentation issues are not the highest priority though... https://github.com/screeps/docs/issues/72 13 days without answer and counting. So I guess the question about how to report issues so that they are seen is a valid one. @o4kapuk can you comment on that? Are devs just busy working on higher priorities or nobody watches those without any poke from somewhere else? Not that I am particularly interested in this issue, but I have some more waiting to be reported when I get to know how to do it with any effect.
-
@Zyzyzyryxy Devs usually review PRs in batches from time to time, usually once per week or two. I'll remind them about pending PRs review.
-
@o4kapuk it might not be a bad idea if the community managers could pull in documentation changes. I can get why the admins wouldn't want code changes being pulled in without their review but the documentation should be less sensitive. Just for the small changes at least, not for the big articles that they give our rewards for.
-
@tedivm said in Documentation improvements:
@o4kapuk it might not be a bad idea if the community managers could pull in documentation changes.
Great idea.
@o4kapuk http://docs.screeps.com/api/#Creep.getActiveBodyparts is missing CLAIM, though the function does not exclude it.
-
@mashee Mashee, you can create a pull request
-
@starwar15432 said in Documentation improvements:
@mashee Mashee, you can create a pull request
Yeah, I know. Even in complete acknowledgement of a programming development style game
, I would still rather jump off a bridge than log into git...
http://steamcommunity.com/app/464350/discussions/0/1471969431582677596/Don't get me wrong...I'm appreciative of the transparency on all fronts, inc git, but this is a first and foremost a game for the player, not a job.
-
This post is deleted!