Page 1 of 2

Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 26 Feb 2018, 09:47
by nif
Just finished the OpenMW CS "Making Magic Ring Tour" ! W00t ! Got my fancy NightEye ring... added via console.

Anxious to learn more ! If anyone would care to elaborate on the yet to be completed 'part 2' of that guide - you will have at least one student :)

http://openmw.readthedocs.io/en/master/ ... me-s-world

Adding the ring to the game’s world

Now that we have defined the ring it is time add it to the game world so the player can find it legitimately. We will add the ring to a merchant, place it in a chest and put it somewhere in plain sight. To this end we will have to actually modify the contents of the game.
Subsection to come...
Sounds like fun, do tell us how !

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 04:21
by Thunderforge
These tutorials are on Github. I myself submitted the tutorial for placing the ring in plain sight a month and a half ago.

Does anybody know what needs to be done to get the ReadTheDocs.io pages updated with the latest tutorials?

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 08:39
by nif
Wow, that's great thanks for the headsup ! Will follow your part of the guide diligently :)

If I'm not mistaken, the Readthedocs will get updated each releease.

For example, the last official release was in December so your change isn't built to the Readthedocs site yet. Scrawl made docs changes a few days ago that are also not on the Readthedocs site.

But you probably knew that already; I dunno what specifically has to happen for it to build other than someone has setup or does something on release day. Probably an autobuild based on commits or weekly would be better for docs.

But good to know that Github can render .rst - in that case we can at least reference these latest changes in this way.

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 09:50
by psi29a
Looks like the builds have been broken for awhile and no one has raised a fuss until now.

https://readthedocs.org/projects/openmw/builds/6798390/

Looks like someone broke the build... this is a brittle part because it tries to get the OpenMW version number from our cmake files. I'll look into it around lunch.

Code: Select all

python /home/docs/checkouts/readthedocs.org/user_builds/openmw/envs/master/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html
Running Sphinx v1.6.5
making output directory...

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/openmw/envs/master/local/lib/python2.7/site-packages/sphinx/cmdline.py", line 305, in main
    opts.warningiserror, opts.tags, opts.verbosity, opts.jobs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/openmw/envs/master/local/lib/python2.7/site-packages/sphinx/application.py", line 168, in __init__
    confoverrides or {}, self.tags)
  File "/home/docs/checkouts/readthedocs.org/user_builds/openmw/envs/master/local/lib/python2.7/site-packages/sphinx/config.py", line 150, in __init__
    execfile_(filename, config)
  File "/home/docs/checkouts/readthedocs.org/user_builds/openmw/envs/master/local/lib/python2.7/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/home/docs/checkouts/readthedocs.org/user_builds/openmw/envs/master/local/lib/python2.7/site-packages/six.py", line 709, in exec_
    exec("""exec _code_ in _globs_, _locs_""")
  File "<string>", line 1, in <module>
  File "conf.py", line 67, in <module>
    release = version = '.'.join([cmake_data[24][1][1].contents,
IndexError: list index out of range

Exception occurred:
  File "conf.py", line 67, in <module>
    release = version = '.'.join([cmake_data[24][1][1].contents,
IndexError: list index out of range
The full traceback has been saved in /tmp/sphinx-err-tNbEaX.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 12:11
by AnyOldName3
I genuinely thought it was only supposed to update when we do a release. I might have noticed the issue otherwise.

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 14:09
by lysol
AnyOldName3 wrote:
27 Feb 2018, 12:11
I genuinely thought it was only supposed to update when we do a release. I might have noticed the issue otherwise.
+ 1

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 14:58
by psi29a
It does, in addition to every merge of a PR into master ;)

We have multiple versions of the docs on RTD: version releases, master and latest (from HEAD)

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 15:15
by Thunderforge
nif wrote:
27 Feb 2018, 08:39
Wow, that's great thanks for the headsup ! Will follow your part of the guide diligently :)
Glad to hear it! Feel free to submit improvements to the tutorial if you find parts to be confusing or in need of other changes.

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 17:09
by psi29a
Fixed building issues, I made it a bit more generic:
https://github.com/OpenMW/openmw/commit ... b436c6100a

Is everyone's documentation now live?
https://openmw.readthedocs.io/en/master/

Re: Awaiting Part 2 of Tour guide (adding ring to game world)

Posted: 27 Feb 2018, 17:14
by AnyOldName3
The new function in that fix won't be happy if it gets to the end of the file without finding the version string. Is that something that we should worry about?