Merge pull request #846 from RoboCupAtHome/release-2024

Prepare 2024 Release
RoboCupAtHome · Mar 5, 2024 · cea2c1e · cea2c1e
2 parents 01eecfe + fa79d26
commit cea2c1e
Show file tree

Hide file tree

Showing 14 changed files with 131 additions and 145 deletions.
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,4 @@
 *.pdf
 .temp_*
 *.backup
+*.rubbercache
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,22 @@
+# Changelog
+
+[Current Draft]: https://github.com/RoboCupAtHome/RuleBook/compare/2023.2..HEAD
+[2024.1]: https://github.com/RoboCupAtHome/RuleBook/compare/2023.2..2024.1
+[2023.2]: https://github.com/RoboCupAtHome/RuleBook/compare/2023.1..2023.2
+[2023.1]: https://github.com/RoboCupAtHome/RuleBook/compare/2019.v1..2023.1
+
+
+All notable changes to this project will be documented in this file.
+
+## Rulebook [Current Draft]
+
+## Rulebook [2024.1] - 2024-03-05
+* split document into Rulebook and Organization document [(PR)](https://github.com/RoboCupAtHome/RuleBook/pull/831)
+  * RoboCup@Home Rulebook: Rules and Regulations for the competition.
+  * RoboCup@Home Organization document: Rules and Regulations on the organization of the competition
+* [New Command Generator for GPSR](https://github.com/johaq/CommandGenerator/tree/master)
+* updated Task: EGPSR [(PR)](https://github.com/RoboCupAtHome/RuleBook/pull/844)
+  * Robot has to restore the default arena state and requests
+* add a social survey in restaurant and receptionist tasks [(PR)](https://github.com/RoboCupAtHome/RuleBook/pull/839)
+* requesting Deus Ex Machina assistance now requires the robot to show its perception [(PR)](https://github.com/RoboCupAtHome/RuleBook/pull/838)
+* small scoring items for attempting tasks, and more consistent scoring between tests [(PR)](https://github.com/RoboCupAtHome/RuleBook/pull/843)
diff --git a/README.md b/README.md
@@ -1,38 +1,29 @@
-RuleBook for RoboCup @Home 2022
+RuleBook for RoboCup @Home 2024
 ===============================
 
 [![CI](https://github.com/RoboCupAtHome/RuleBook/actions/workflows/ci.yml/badge.svg)](https://github.com/RoboCupAtHome/RuleBook/actions/workflows/ci.yml)
 
-The 2022 rulebook is based on the 2019 rulebook. The current version is **final**; only minor (language) updates and clarifications may be made from now on.
+### PDF Downloads
 
-[On-the-fly compiled LaTeX version](https://robocupathome.github.io/RuleBook/rulebook/master.pdf)
+[Rulebook](https://robocupathome.github.io/RuleBook/rulebook/master.pdf)
+[Organization guidelines](https://robocupathome.github.io/RuleBook/organization/master.pdf)
+[Score sheets](https://robocupathome.github.io/RuleBook/scoresheets/master.pdf)
 
-[Released PDF version](https://athome.robocup.org/wp-content/uploads/2022_rulebook.pdf)
+The current version for 2024 is **final**; only minor (language) updates and clarifications may be made from now on.
+
+[Changelog](CHANGELOG.md)
 
 RoboCup@Home teams and team members are welcome to post GitHub issues for clarifications, questions etc.
 
 Improvements are also welcome in the form of pull requests (see [guidelines](https://github.com/RoboCupAtHome/RuleBook/wiki/Guidelines)).
 
-[Score sheets](https://robocupathome.github.io/RuleBook/scoresheets/master.pdf))
+
 
 ### FAQ
 See the Frequently Asked Questions [here](https://github.com/RoboCupAtHome/RuleBook/wiki/FAQ:-Frequently-Asked-Questions).
 
 Or ask us via Telegram: [https://t.me/RoboCupAtHome](https://t.me/RoboCupAtHome)
 
-### Change log
-The Rulebook has being completely restructured for 2019 and later competitions.
-The new format was first tested at German Open 2019.
-
-#### Highlights
-- **Less stressful competition:** Each competition day will have 2 *testing blocks* (e.g.from 9:00 to 12:00 and from 15:00 to 18:00), giving time to teams to eat, rest, and prepare.
-- **Thematic *free* testing:** Each *testing block* will have assigned a *scenario*, namely cleaning the house or hosting a party. Teams will have assigned at least 2 testing slots to solve the *task* of their choise.
-- **Task-driven testing:** Tests are no more. The rulebook will have a battery of tasks featuring different abilities from which teams can choose which to solve. It won't be possible to solve all tasks.
-- **Goal-driven scoring:** A robot can only score by accomplishing the *main goal* of a *task*. In addition to the *main goal*, several bonus objectives are available with juicy rewards, but will be only considered if the *main goal* is completed.
-- **Unlimited *Continues*:** The continue rule is no more. Instead, robots may call for a *Deus Ex Machina* and have human assistant helping it to solve the task. There is no limit on the number of times a robot can ask for help, and the nature of the help is unconstrained. Nonetheless, a proportional score reduction applies.
-
-These changes obey to one objective: **robots must succeed**.
-
 
 ### Question, issues, and contribution Guidelines
 - When asking questions [please follow these Guidelines](https://github.com/RoboCupAtHome/RuleBook/wiki/Guidelines:-Questions).

diff --git a/citation.bib b/citation.bib
diff --git a/citation_organization.bib b/citation_organization.bib
@@ -0,0 +1,11 @@
+@misc{rulebook_orga_2024,
+  author =       {Hart, Justin and Moriarty, Alexander and Pasternak, Katarzyna
+                  and Kummert, Johannes and Hawkin, Alina and Hassouna, Vanessa
+                  and Pena Narvaez, Juan Diego and Ruegemer, Leroy
+                  and von Seelstrang, Leander and Van Dooren, Peter 
+                  and Garcia, Juan Jose, and Mitzutani, Akinobu 
+                  and Jiang, Yuqian and Matsushima, Tatsuya and Polvara, Riccardo},
+  title =        {RoboCup@Home 2024: Regulations on the organization of the competition},
+  year =         {2024},
+  howpublished = {\url{https://github.com/RoboCupAtHome/RuleBook/releases/tag/2024.1}},
+}
diff --git a/citation_rulebook.bib b/citation_rulebook.bib
@@ -0,0 +1,11 @@
+@misc{rulebook_2024,
+  author =       {Hart, Justin and Moriarty, Alexander and Pasternak, Katarzyna
+                  and Kummert, Johannes and Hawkin, Alina and Hassouna, Vanessa
+                  and Pena Narvaez, Juan Diego and Ruegemer, Leroy
+                  and von Seelstrang, Leander and Van Dooren, Peter 
+                  and Garcia, Juan Jose, and Mitzutani, Akinobu 
+                  and Jiang, Yuqian and Matsushima, Tatsuya and Polvara, Riccardo},
+  title =        {RoboCup@Home 2024: Rules and Regulations},
+  year =         {2024},
+  howpublished = {\url{https://github.com/RoboCupAtHome/RuleBook/releases/tag/2024.1}},
+}
diff --git a/organization.tex b/organization.tex
@@ -39,7 +39,8 @@
 	\setcounter{page}{0}
 	\pagenumbering{roman}
 	\pagestyle{empty}
-	\input{organization/acknowledgments}
+	\input{organization/about}
+	\input{pages/acknowledgments}
 	\clearpage
 
 	\pagestyle{plain}

diff --git a/organization/about.tex b/organization/about.tex
@@ -0,0 +1,30 @@
+%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%%          $Id: about.tex 
+%%    author(s): RoboCupAtHome Technical Committee(s)
+%%  description: About for the RoboCupAtHome organization guidelines
+%%
+%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section*{About this document}
+These are the organization guidelines of the RoboCup@Home competition \YEAR. It contains the procedures surrounding the Robocup@Home competition. Both those leading up to the event and those in place during the competition. This document excludes the tests the robot are expected to perform and the scores associated with them. Those can be found in the \Rulebook.
+This document has been written by the \YEAR ~RoboCup@Home Technical Committee.
+
+\section*{How to cite this document}
+If you refer to RoboCup@Home and this document in particular, please cite:\\
+
+\noindent Justin Hart, Alexander Moriarty, Katarzyna Pasternak, Johannes Kummert,
+Alina Hawkin, Vanessa Hassouna, Juan Diego Pena Narvaez, Leroy Ruegemer,
+Leander von Seelstrang, Peter Van Dooren, Juan Jose Garcia, Akinobu Mitzutani,
+Yuqian Jiang, Tatsuya Matsushima, Riccardo Polvara
+\enquote{Robocup@Home \YEAR: Competition organization document,}
+\url{https://github.com/RoboCupAtHome/RuleBook/releases/download/2024.1/organization.pdf}, \YEAR.
+
+\begin{center}
+	\begin{minipage}{0.8\textwidth}
+		\footnotesize%
+		\verbatiminput{citation_organization.bib}
+	\end{minipage}
+\end{center}
+
+\pagebreak
diff --git a/organization/acknowledgments.tex b/organization/acknowledgments.tex
diff --git a/pages/acknowledgments.tex b/pages/acknowledgments.tex
@@ -6,32 +6,6 @@
 %%
 %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-
-
-\section*{About this rulebook}
-This is the official rulebook of the RoboCup@Home competition \YEAR. It contains the tests performed by the robots and the scoring associated with it. But excludes the organisational details, which can be found in the \Organisation.
-The rulebook has been written by the \YEAR ~RoboCup@Home Technical Committee.
-% Mauricio Matamoros,
-% and
-% Loy van Beek.
-
-
-
-\section*{How to cite this rulebook}
-If you refer to RoboCup@Home and this rulebook in particular, please cite:\\
-
-\noindent Justin Hart, Mauricio Matamoros, Alexander Moriarty, Hiroyuki Okada,
-Matteo Leonetti, Alex Mitrevski, Katarzyna Pasternak, and Fagner Pimentel
-\enquote{Robocup@Home \YEAR: Rule and regulations,}
-\url{https://athome.robocup.org/rules/\YEAR_rulebook.pdf}, \YEAR.
-
-\begin{center}
-	\begin{minipage}{0.8\textwidth}
-		\footnotesize%
-		\verbatiminput{citation.bib}
-	\end{minipage}
-\end{center}
-
 \section*{Acknowledgments}
 \label{sec:acknowledgments}
 We would like to thank the members of the Technical Committee who put up the rules and the Organizing Committee who organizes the competition.
@@ -45,14 +19,19 @@ \section*{Acknowledgments}
 			Akinobu Mizutani\\
 			Alex Mitrevski\\
 			Alexander Moriarty\\
+			Alina Hawkin\\
 			Caleb Rascon\\
 			Fagner Pimentel\\
 			Florian Lier\\
 			Hiroyuki Okada\\
 			Johannes Kummert\\
+			Juan Diego Pena Narvaez\\
+			Juan Jose Garcia\\
 			Justin Hart\\
 			Katarzyna Pasternak\\
 			Komei Sugiura\\
+			Leander von Seelstrang\\
+			Leroy Ruegemer\\
 			Loy van Beek\\
 			Luca Iocchi\\
 			Luca Lach\\
@@ -62,11 +41,15 @@ \section*{Acknowledgments}
 			Maxime St-Pierre\\
 			Peter van Dooren\\
 			Raphael Memmesheimer\\
+			Riccardo Polvara\\
 			Sammy Pfeiffer\\
 			Sebastian Meyer zu Borgsen\\
 			Sven Wachsmuth\\
+			Tatsuya Matsushima\\
 			Tijn van der Zant\\
-			Yuma Yoshimoto
+			Vanessa Hassouna\\
+			Yuma Yoshimoto\\
+			Yuqian Jiang
 		\end{multicols}
 	\end{minipage}
 \end{center}

diff --git a/rulebook.tex b/rulebook.tex
@@ -38,12 +38,13 @@
 
 \begin{document}
 
-\input{./pages/titlepage}
+\input{./rulebook_pages/titlepage}
 
 \setcounter{page}{0}
 \pagenumbering{roman}
 \pagestyle{empty}
-\input{./pages/acknowledgments}
+\input{rulebook_pages/about}
+\input{pages/acknowledgments}
 \clearpage
 
 \pagestyle{plain}

diff --git a/rulebook_pages/about.tex b/rulebook_pages/about.tex
@@ -0,0 +1,30 @@
+%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%%          $Id: about.tex 
+%%    author(s): RoboCupAtHome Technical Committee(s)
+%%  description: About for the RoboCupAtHome RuleBook
+%%
+%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section*{About this rulebook}
+This is the official rulebook of the RoboCup@Home competition \YEAR. It contains the tests performed by the robots and the scoring associated with it. But excludes the organisational details, which can be found in the \Organisation.
+The rulebook has been written by the \YEAR ~RoboCup@Home Technical Committee.
+
+\section*{How to cite this rulebook}
+If you refer to RoboCup@Home and this rulebook in particular, please cite:\\
+
+\noindent Justin Hart, Alexander Moriarty, Katarzyna Pasternak, Johannes Kummert,
+Alina Hawkin, Vanessa Hassouna, Juan Diego Pena Narvaez, Leroy Ruegemer,
+Leander von Seelstrang, Peter Van Dooren, Juan Jose Garcia, Akinobu Mitzutani,
+Yuqian Jiang, Tatsuya Matsushima, Riccardo Polvara
+\enquote{Robocup@Home \YEAR: Rule and regulations,}
+\url{https://github.com/RoboCupAtHome/RuleBook/releases/download/2024.1/rulebook.pdf}, \YEAR.
+
+\begin{center}
+	\begin{minipage}{0.8\textwidth}
+		\footnotesize%
+		\verbatiminput{citation_rulebook.bib}
+	\end{minipage}
+\end{center}
+
+\pagebreak
diff --git a/pages/titlepage.tex → rulebook_pages/titlepage.tex b/pages/titlepage.tex → rulebook_pages/titlepage.tex
diff --git a/setup/active_version.tex b/setup/active_version.tex
@@ -1,6 +1,6 @@
 \newcommand{\YEAR}{2024}
-\newcommand{\STATE}{Draft}
-% \newcommand{\STATE}{Final}
+%\newcommand{\STATE}{Draft}
+\newcommand{\STATE}{Final}
 %
 % Local Variables:
 % TeX-master: "../Rulebook"
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,3 +27,4 @@ @@
     *.pdf
     .temp_*
     *.backup
+    *.rubbercache