logo

overlay

My own overlay for experimentations, use with caution, no support is provided git clone https://hacktivis.me/git/overlay.git

renpy.1 (4642B)

    

  1. .\" Copyright © 2015 Andrew Savchenko
  2. .\" Distributed under the terms of GNU FDL-1.3+ license,
  3. .\" based on original Ren'Py documentation licensed under MIT.
  4. .TH renpy 1 "31 May 2015" "Ren'Py" "Ren'Py Gentoo's manual"
  5. .SH NAME
  6. renpy \- a visual novel engine
  8. .SH SYNOPSIS
  9. .BI renpy " game_directory"
  10. .\" ****************************************************************
  11. .SH DESCRIPTION
  13. .B renpy
  14. (Ren'Py) is a visual novel engine \- used by hundreds of creators
  15. from around the world \- that helps you use words, images, and
  16. sounds to tell interactive stories that run on computers and mobile
  17. devices. These can be both visual novels and life simulation games.
  18. The easy to learn script language allows anyone to efficiently
  19. write large visual novels, while its 
  20. .BR python (1)
  21. scripting is enough for complex simulation games.
  22. .\" ****************************************************************
  23. .SH RUNNING A GAME
  25. In order to run a game, provide
  26. .I game_directory
  27. as an argument to
  28. .BR renpy .
  29. Exact directory name may vary depending or a game, but usually
  30. this path corresponds to
  31. .I */game
  32. wildcard and contains
  33. .I script_version.rpy*
  34. file within. Game directory usually contains other
  35. .IR *.rpy* " and  " *.rpa " files."
  37. One may use
  38. .BR find (1)
  39. tool to locate required directory within unpacked game top
  40. directory:
  41. .RS
  43. find -O3 
  44. .I top_directory
  45. -type f -iname "script_version.rpy*"
  47. .RE
  48. A directory one level above may be provided as an argument as well.
  49. .\" ****************************************************************
  50. .SH PORTABILITY
  52. All
  53. .B renpy
  54. games are written in
  55. .BR python (1),
  56. so one can run then on any platform and architecture.
  58. As you may have noticed, Ren'Py games are often distributed in
  59. different archives for different architectures. This happens due to
  60. bundling of
  61. .BR python (1)
  62. interpreter and required libraries in a game's tarball. Since you
  63. are using OS native
  64. .B renpy
  65. setup, you should be able to run any of these games.
  66. .\" ****************************************************************
  67. .SH GAMES CATALOGUE
  69. A large catalogue of Ren'Py powered games is available at
  70. .IR http://games.renpy.org/ .
  71. .\" ****************************************************************
  72. .SH TROUBLESHOOTING
  74. In some cases game may fail to run with current
  75. .B renpy
  76. version due to various errors.
  78. In such case please try to use the closest
  79. .B renpy
  80. version to one used by game developer. Most games contain
  81. .IR script_version.rpy " file in the " game " directory."
  82. This file actually contains
  83. .B renpy
  84. version used during a game build.
  85. You may install multiple slots of
  86. .B renpy
  87. in Gentoo and use
  88. .BI eselect " renpy"
  89. module to switch between various versions.
  91. If
  92. .I game
  93. directory contains both 
  94. .IR *.rpyc " (or " *.rpyo ") and " *.rpy " files, delete"
  95. .IR *.rpyc " (or " *.rpyo ") files, they will be regenerated by"
  96. the interpreter.
  97. Another solution will be to switch between version of
  98. .BR python (1)
  99. using
  100. .IR eselect (1)
  101. tool in order to find one suitable to interpret game's
  102. .IR *.rpyc " files."
  104. Some games may lack general media files, e.g.
  105. .I click.ogg
  106. sound, so you should create or download one and place in the
  107. .I game
  108. directory.
  110. Also please pay attention to
  111. .I problems.html
  112. page from
  113. .B renpy
  114. html documentation, see
  115. .B FURTHER READING
  116. section.
  117. .\" ****************************************************************
  118. .SH ENVIRONMENT VARIABLES
  120. .B renpy
  121. supports a number of environment variables to control its
  122. behaviour. Please refer to html docs for further details
  123. (see
  124. .B FURTHER READING
  125. section).
  126. .\" ****************************************************************
  127. .SH FURTHER READING
  129. .B renpy
  130. comes with extensive html documentation. To use it install
  131. .B renpy
  132. with
  133. .I USE="doc"
  134. and go to 
  135. .I /usr/share/doc/renpy-*/html/doc/index.html
  137. Alternatively one may refer to online documentation:
  138. .IR http://www.renpy.org/doc/html/ .
  139. Be warned that online docs maybe different from your current active
  140. version, so it recommended to use shipped documentation instead.
  141. .\" ****************************************************************
  142. .SH BUGS
  144. Any bugs related to Gentoo packaging (e.g. omitted dependencies)
  145. please report on bugzilla:
  146. .IR https://bugs.gentoo.org .
  148. For bugs in the Ren'Py engine itself, please contact upstream:
  149. .I https://github.com/renpy/renpy/issues
  150. and add a Gentoo bug if you feel it necessary.
  152. For issues with games themselves please contact corresponding
  153. authors.
  154. .\" ****************************************************************
  155. .SH SEE ALSO
  157. .BR python (1)
  158. \- an interpreter used by Ren'Py engine.
  160. .BR unrpa (1)
  161. \- a tool to unpack
  162. .I *.rpa
  163. data files (Ren'Py Archives).