Skip to content

Commit

Permalink
docs: auto update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Falcon committed Jun 16, 2024
1 parent a567f95 commit 3a4ebd8
Showing 1 changed file with 1 addition and 15 deletions.
16 changes: 1 addition & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,20 +123,6 @@ This should satisfy the dependencies and you can start right away.
Getting Started
---------------

If you want to start with the Software-Challenge Python Client, you have
to import some dependencies first.

The following are all possible imports which are available. You won't
need every, but for the sake of completeness all are listed.

.. code:: python
from socha import Accelerate, AccelerationProblem, Advance, AdvanceInfo, AdvanceProblem, Board
from socha import CartesianCoordinate, CubeCoordinates, CubeDirection, Field, FieldType, GameState
from socha import Move, Passenger, Push, PushProblem, Segment, Ship, TeamEnum, TeamPoints, Turn, TurnProblem
from socha.api.networking.game_client import IClientHandler
from socha.starter import Starter
If you now want to develop and implement your logic, then the structure
of the class should look like this.

Expand All @@ -146,7 +132,7 @@ of the class should look like this.
gameState: GameState
def calculate_move(self) -> Move:
return Move([Advance(1)])
return Move(action=Advance(distance=1, cards=[]))
def on_update(self, state: GameState):
self.gameState = state
Expand Down

0 comments on commit 3a4ebd8

Please sign in to comment.