Project

General

Profile

Wiki » History » Version 45

Leszek Koltunski, 09/25/2020 09:57 AM

1 2 Distorted Admin
h1. Overview
2 1 Distorted Admin
3 42 Leszek Koltunski
Magic Cube is an application which lets one play with various TwistyObjects. Currently implemented objects are listed below in the 'How to add a new Object' section. 
4
The app contains graphics effects provided by the "Distorted":https://distorted.org/redmine/projects/distorted-android/wiki/wiki library.
5 5 Distorted Admin
Users can submit their best times to a central High Scores list and download results made by others.
6 36 Distorted Admin
7 35 Distorted Admin
Additionally there's a near-perfect, instantenous 3x3x3 Cube Solver (Kociemba) and a about 2000 Pretty Patterns (more in the plans!).
8 5 Distorted Admin
9 2 Distorted Admin
Magic Cube is open source and released under the terms of the "GNU General Public License v2":http://www.gnu.org/licenses/old-licenses/gpl-2.0.html (GPL).
10 1 Distorted Admin
11 32 Distorted Admin
h1. Downloads
12
13 33 Distorted Admin
Google play     : https://play.google.com/store/apps/details?id=org.distorted.magic
14
Amazon App Store: https://www.amazon.co.uk/Developer-Magic-Cube/dp/B0875PSWTK
15 32 Distorted Admin
16 2 Distorted Admin
h1. Source code
17 1 Distorted Admin
18 2 Distorted Admin
<pre>
19 1 Distorted Admin
git clone http://distorted.org/git/distorted-library.git
20
git clone http://distorted.org/git/distorted-cube.git 
21 2 Distorted Admin
</pre>
22 3 Distorted Admin
23 43 Leszek Koltunski
h1. Screenshots
24
25 45 Leszek Koltunski
!CUBE3.png! !PYRA3.png! !DINO.png! !SKEWB.png! !HELI.png!
26 43 Leszek Koltunski
27 3 Distorted Admin
h1. Tutorials
28 13 Distorted Admin
29 30 Distorted Admin
30 34 Distorted Admin
h2. How to add a new Object
31 3 Distorted Admin
32 39 Leszek Koltunski
* Write a new class which extends "TwistyObject":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyObject.java (this one defines the Object itself)
33
* Write a new class which extends "Movement":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/Movement.java (this one defines the connection between finger swipes on the screen and Object rotations)
34 37 Leszek Koltunski
* add your new classes to the "ObjectList":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/ObjectList.java enum (here you will also need to provide a small icon to add to the "play" drop-down object list)
35 20 Distorted Admin
36
and your new Object will automatically become available in the "Play" drop-down list.
37 3 Distorted Admin
38 40 Leszek Koltunski
Currently implemented Objects: a "Cube":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyCube.java , a "Pyraminx":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyPyraminx.java , a "6-color Dino":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyDino6.java , a "4-color Dino":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyDino4.java , a "Skewb":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistySkewb.java , a "Helicopter":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyHelicopter.java , and a "Diamond Skewb":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/objects/TwistyDiamond.java
39 3 Distorted Admin
40 30 Distorted Admin
41 3 Distorted Admin
h2. How to add a new Transition Effect
42
43 25 Distorted Admin
If you would like to add, say, a new WIN effect (i.e. animation which happens when the Object gets solved) all you need to do is add a new class which extends "org.distorted.effect.WinEffect":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/effects/win/WinEffect.java and add the new class to the "org.distorted.effect.WinEffect.Type":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/effects/win/WinEffect.java enum. 
44 15 Distorted Admin
45 16 Distorted Admin
The new effect will automatically become available in the "Effects dialog":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/dialogs/RubikDialogEffects.java.
46 17 Distorted Admin
47 30 Distorted Admin
48 17 Distorted Admin
h2. How to add a new Pretty Pattern
49
50 41 Leszek Koltunski
If you've got a collection of Pretty Patterns for a given (already implemented!) TwistyObject, say a Pyraminx 3x3x3, all you need to do to connect it to the Magic Cube is to create a table of Strings describing the patterns ( format needs to follow the one already done in "Cube Patterns":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/patterns/RubikPatternCube3.java ) and add the new pattern list to the "org.distorted.patterns.RubikPatternList":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/patterns/RubikPatternList.java enum.
51 17 Distorted Admin
52
The new list of Patterns will automatically become available in the "Patterns dialog":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/dialogs/RubikDialogPattern.java.
53 18 Distorted Admin
54 30 Distorted Admin
55 18 Distorted Admin
h2. How to add a new Solver
56 1 Distorted Admin
57 31 Distorted Admin
Work in the "org.distorted.solvers":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/show/src/main/java/org/distorted/solvers package. First create a subdirectory containing the code of your actual solver, then connect it to the rest of the program by modifying the "org.distorted.solvers.SolverMain":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/solvers/SolverMain.java class, and finally add the new solver to the "org.distorted.solvers.ImplementedSolversList":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/entry/src/main/java/org/distorted/solvers/ImplementedSolversList.java enum.
58 18 Distorted Admin
59 19 Distorted Admin
Currently implemented solvers: "a near-perfect, instantenous Cube3 solver":https://distorted.org/redmine/projects/magic-cube/repository/magiccube/revisions/master/show/src/main/java/org/distorted/solvers/cube3.